HTMLHint

A Static Code Analysis Tool for HTML.

Version

0.9.13

Runtime

Node.js v6.9.5 npm 3.10.10

Supported Languages

HTML

Official Documentation

http://htmlhint.com/

YAML Configuration

htmlhint:

  • input:

    Patterns to include in execution and reports.

  • ignore:

    Patterns to exclude from execution and reports.

  • auto-fix:

    N/A

  • config-file:

    Alias of --config option.

  • machine:

    • cpu:

      Amount of CPU. The default machine has 0.25 CPU with 960 MiB RAM.

  • options:

    Below is the list of options that are supported:

    -c, --config <file>                                         custom configuration file
    -r, --rules <ruleid, ruleid=value ...>                      set all of the rules available
    -R, --rulesdir <file|folder>                                load custom rules from file or folder

    Note: -i, --ignore options are not supported as of now, use ignore: instead.

  • experimental:

    • incremental:

      true/false

      Note: The incremental analysis is disabled if any kinds of configuration files are changed. The files recognized as configuration files are as follows:

      • Configuration files:
        • Files specified in config-file field
        • Files specified to -c, --config options
        • If none of the above configuration files are found:
          • **/.htmlhintrc
      • Rules files:
        • Files directly specified to -R, --rulesdir options
        • <rulesdir>/**/*.js where <rulesdir> is one of the directories specified to -R, --rulesdir options

YAML Examples

  • With default options:

    inspecode:
      htmlhint: default
  • With custom machine:

    inspecode:
      htmlhint:
        machine:
          cpu: 1.5 # 1.5 CPU, 5760 MiB RAM
  • With custom options:

    inspecode:
      htmlhint:
        options:
          --rules: tag-pair,id-class-value=underline
  • With a configuration file:

    inspecode:
      htmlhint:
        config-file: ./my-htmlhint.conf

    The above configuration is equivalent to:

    inspecode:
      htmlhint:
        options:
          --config: ./my-htmlhint.conf

Configuration File Detection

If no configuration files are specified via config-file or options field, Inspecode lets HTMLHint to find configuration files in your repository. See https://github.com/yaniswang/HTMLHint/wiki/Usage#cli about how HTMLHint looks for configuration files.

In addition, if HTMLHint cannot find any configuration files, Inspecode also walks the file tree in lexical order in your repository to find a configuration file named .htmlhintrc and specifies the file first found to HTMLHint automatically via --config option.

Note: Inspecode ignores specific configuration files while searching. See Configuration > Tool Configuration > Field: config-file for detail.

If the configuration file detected by Inspecode is not the one you want to use or you do not want to use any configuration files, you can disable Inspecode from detecting configuration files by explicitly setting an empty string to config-file field like below:

inspecode:
  htmlhint:
    config-file: ""

results matching ""

    No results matching ""