This site uses cookies for analytics. By continuing to browse this site, you agree to this use.



A formatter takes the results of executing the configured hints and transforms them to be consumed by the user. A formatter can output results to a file or the console, in various styles.

To choose a formatter, install its package and add that package name to the formatters array within your .hintrc file. Packages within the @hint/ namespace (like, for example, @hint/formatter-html) can be added using their short name.

    "formatters": ["html"]

Since .hintrc accepts formatters as an array of strings, you can specify more than one. An example use case would be wanting a summary printed to the console as well as a full html report.

    "formatters": [

Or perhaps you wish you use a custom formatter in addition to or instead of the official packages. Any package matching the pattern @hint/formatter-, webhint-formatter-, or @scope/webhint-formatter- should be a valid candidate.

npm i -D @myOrg/webhint-formatter-bubble-letters
    "formatters": [

List of official formatters

The officially supported formatters that can be installed via npm are:

  • @hint/formatter-json does a JSON.stringify() of the results. Output is not user friendly:

    Example output for the json formatter

  • @hint/formatter-stylish prints the results in table format indicating the resource, line, and column:

    Example output for the stylish formatter

  • @hint/formatter-codeframe shows also the code where the error was found if applicable:

    Example output for the codeframe formatter

  • @hint/formatter-summary shows a summary of all the warnings and errors found for all the resources:

    Example output for the summary formatter

  • @hint/formatter-excel creates an Excel spreadsheet with a sheet containing the results per resource:

    Example output for the summary sheet of the excel formatter

    Example output for one of the details sheet of the excel formatter

  • @hint/formatter-html creates an HTML page in the folder hint-report/<url_analyzed> with the result:

    Example out for the HTML result of the html formatter

    Note: If you are running custom hints, the buttons “Why is this important” and “How to solve it” will not work.

If you want to implement your own formatter, visit the contributor guide.