HTML Report

The HTML lint report can be exported from the GUI (see Main Tab and Generate and Open Resources chapters) or by using the batch mode flag ‘gen_html_report’.

The report is divided in 3 panels.

1. Summary Page or Hits Page (right)

2. Categories and Checks Tree (middle)

3. Filters (left)

Summary Page

Summary page contains statistics charts and top failures from current state of the report.

To toggle between summary page and hits page you can use the following button .

Donut charts represent the ratio of errors/warnings/infos/passed checks or hits.

Under the charts, checks and files with the highest number of failures are displayed.

Hovering over the checks or files will pop-up a filtering button that can be used to add that check or file to the filters.

Hits Page

The page appears when a check or category is selected in the tree or when the following button is pressed .

The hits table contains all the hits of the selected check or category and allows filtering and sorting.

To sort the table after severity, check, file or line, click on the column header of that specific property. Multiple sorting can be achieved by holding Shift pressed when clicking on the column header.

Hovering over the checks or files column will pop-up a filtering button that can be used to add that check or file in the filters.

Above the hits table a quick filter bar is displayed. It can be used to filter furthermore the hits displayed in the table. The quick filter applies to any information (check, file, line, message) available in the table and only the matching rows will show in the table.

The small chart above the quick filter represents the ratio and absolute values of hit severities displayed in the table.

Below the hits table a details area shows the information of the selected category, check and hit.

Categories and Checks Tree

Selecting a check or category in the tree will display the hits table for it. The details area will be updated with the information about that category or check.

The status of a category or a check is computed based on the contained hits.

Filters

Filters work on the information displayed in all components (summary page, checks tree, hits table).

Status filters are filtering out the hits and checks that don’t match and are applied on selection.

Checks and files filters are filtering out the hits and checks that don’t contain match. They are applied only when Reapply Filters button is pressed. The filters can also contain regular expressions.

To save the state of the report (filters, selected checks, etc.) the save button can be used. Clicking it will show the URL needed to open the report in the same state .