Skip to content

htmlhint

htmlhint documentation

HTMLHint - GitHub

Configuration in MegaLinter

Variable Description Default value
HTML_HTMLHINT_ARGUMENTS User custom arguments to add in linter CLI call
Ex: -s --foo "bar"
HTML_HTMLHINT_FILTER_REGEX_INCLUDE Custom regex including filter
Ex: (src\|lib)
Include every file
HTML_HTMLHINT_FILTER_REGEX_EXCLUDE Custom regex excluding filter
Ex: (test\|examples)
Exclude no file
HTML_HTMLHINT_CLI_LINT_MODE Override default CLI lint mode
- file: Calls the linter for each file
- list_of_files: Call the linter with the list of files as argument
- project: Call the linter from the root of the project
list_of_files
HTML_HTMLHINT_FILE_EXTENSIONS Allowed file extensions. "*" matches any extension, "" matches empty extension. Empty list excludes all files
Ex: [".py", ""]
[".html", ".htm"]
HTML_HTMLHINT_FILE_NAMES_REGEX File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: ["Dockerfile(-.+)?", "Jenkinsfile"]
Include every file
HTML_HTMLHINT_PRE_COMMANDS List of bash commands to run before the linter None
HTML_HTMLHINT_POST_COMMANDS List of bash commands to run after the linter None
HTML_HTMLHINT_CONFIG_FILE htmlhint configuration file name
Use LINTER_DEFAULT to let the linter find it
.htmlhintrc
HTML_HTMLHINT_RULES_PATH Path where to find linter configuration file Workspace folder, then MegaLinter default rules
HTML_HTMLHINT_DISABLE_ERRORS Run linter but consider errors as warnings false
HTML_HTMLHINT_DISABLE_ERRORS_IF_LESS_THAN Maximum number of errors allowed 0

IDE Integration

Use htmlhint in your favorite IDE to catch errors before MegaLinter !

IDE Extension Name Install
Atom atom-htmlhint Visit Web Site
Brackets brackets-htmlhint Visit Web Site
Sublime Text SublimeLinter-contrib-htmlhint Visit Web Site
Visual Studio Code vscode-htmlhint Install in VsCode

MegaLinter Flavours

This linter is available in the following flavours

Flavor Description Embedded linters Info
all Default MegaLinter Flavor 97 Docker Image Size (tag) Docker Pulls
dart Optimized for DART based projects 42 Docker Image Size (tag) Docker Pulls
documentation MegaLinter for documentation projects 41 Docker Image Size (tag) Docker Pulls
dotnet Optimized for C, C++, C# or VB based projects 49 Docker Image Size (tag) Docker Pulls
go Optimized for GO based projects 43 Docker Image Size (tag) Docker Pulls
java Optimized for JAVA based projects 43 Docker Image Size (tag) Docker Pulls
javascript Optimized for JAVASCRIPT or TYPESCRIPT based projects 50 Docker Image Size (tag) Docker Pulls
php Optimized for PHP based projects 46 Docker Image Size (tag) Docker Pulls
python Optimized for PYTHON based projects 49 Docker Image Size (tag) Docker Pulls
ruby Optimized for RUBY based projects 42 Docker Image Size (tag) Docker Pulls
rust Optimized for RUST based projects 42 Docker Image Size (tag) Docker Pulls
salesforce Optimized for Salesforce based projects 44 Docker Image Size (tag) Docker Pulls
scala Optimized for SCALA based projects 42 Docker Image Size (tag) Docker Pulls
swift Optimized for SWIFT based projects 42 Docker Image Size (tag) Docker Pulls
terraform Optimized for TERRAFORM based projects 47 Docker Image Size (tag) Docker Pulls

Behind the scenes

How are identified applicable files

  • File extensions: .html, .htm

How the linting is performed

  • htmlhint is called once with the list of files as arguments

Example calls

htmlhint myfile.html
htmlhint --config .htmlhintrc myfile.html

Help content

Usage: htmlhint <file|folder|pattern|stdin|url ...> [options]

Options:
  -V, --version                                                    output the version number
  -l, --list                                                       show all of the rules available
  -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
  -f, --format <checkstyle|compact|html|json|junit|markdown|unix>  output messages as custom format
  -i, --ignore <pattern, pattern ...>                              add pattern to exclude matches
  --nocolor                                                        disable color
  --warn                                                           Warn only, exit with 0
  -h, --help                                                       display help for command
  Examples:

    htmlhint
    htmlhint www
    htmlhint www/test.html
    htmlhint www/**/*.xhtml
    htmlhint www/**/*.{htm,html}
    htmlhint http://www.alibaba.com/
    cat test.html | htmlhint stdin
    htmlhint --list
    htmlhint --rules tag-pair,id-class-value=underline test.html
    htmlhint --config .htmlhintrc test.html
    htmlhint --ignore **/build/**,**/test/**
    htmlhint --rulesdir ./rules/

Installation on mega-linter Docker image

Example success log

Results of htmlhint linter (version 0.14.2)
See documentation on https://megalinter.github.io/descriptors/html_htmlhint/
-----------------------------------------------

[SUCCESS] .automation/test/html/html_good_01.html

       Config loaded: /action/lib/.automation/.htmlhintrc

    Scanned 1 files, no errors found (22 ms).

Example error log

Results of htmlhint linter (version 0.14.2)
See documentation on https://megalinter.github.io/descriptors/html_htmlhint/
-----------------------------------------------

[ERROR] .automation/test/html/html_bad_01.html

       Config loaded: /action/lib/.automation/.htmlhintrc

       .automation/test/html/html_bad_01.html
          L8 |  <div bad='' bad=''></div>
                    ^ The value of attribute [ bad ] must be in double quotes. (attr-value-double-quotes)
          L8 |  <div bad='' bad=''></div>
                           ^ The value of attribute [ bad ] must be in double quotes. (attr-value-double-quotes)
          L8 |  <div bad='' bad=''></div>
                           ^ Duplicate of attribute name [ bad ] was found. (attr-no-duplication)
          L9 |  <div bad='' bad=''></div>
                    ^ The value of attribute [ bad ] must be in double quotes. (attr-value-double-quotes)
          L9 |  <div bad='' bad=''></div>
                           ^ The value of attribute [ bad ] must be in double quotes. (attr-value-double-quotes)
          L9 |  <div bad='' bad=''></div>
                           ^ Duplicate of attribute name [ bad ] was found. (attr-no-duplication)
          L10 |  <div bad='' bad=''></div>
                     ^ The value of attribute [ bad ] must be in double quotes. (attr-value-double-quotes)
          L10 |  <div bad='' bad=''></div>
                            ^ The value of attribute [ bad ] must be in double quotes. (attr-value-double-quotes)
          L10 |  <div bad='' bad=''></div>
                            ^ Duplicate of attribute name [ bad ] was found. (attr-no-duplication)
          L11 |  <div bad='' bad=''></div>
                     ^ The value of attribute [ bad ] must be in double quotes. (attr-value-double-quotes)
          L11 |  <div bad='' bad=''></div>
                            ^ The value of attribute [ bad ] must be in double quotes. (attr-value-double-quotes)
          L11 |  <div bad='' bad=''></div>
                            ^ Duplicate of attribute name [ bad ] was found. (attr-no-duplication)
          L12 |  <div bad='' bad=''></div>
                     ^ The value of attribute [ bad ] must be in double quotes. (attr-value-double-quotes)
          L12 |  <div bad='' bad=''></div>
                            ^ The value of attribute [ bad ] must be in double quotes. (attr-value-double-quotes)
          L12 |  <div bad='' bad=''></div>
                            ^ Duplicate of attribute name [ bad ] was found. (attr-no-duplication)
          L13 |  <div bad='' bad=''></div>
                     ^ The value of attribute [ bad ] must be in double quotes. (attr-value-double-quotes)
          L13 |  <div bad='' bad=''></div>
                            ^ The value of attribute [ bad ] must be in double quotes. (attr-value-double-quotes)
          L13 |  <div bad='' bad=''></div>
                            ^ Duplicate of attribute name [ bad ] was found. (attr-no-duplication)
          L14 |  <div bad='' bad=''></div>
                     ^ The value of attribute [ bad ] must be in double quotes. (attr-value-double-quotes)
          L14 |  <div bad='' bad=''></div>
                            ^ The value of attribute [ bad ] must be in double quotes. (attr-value-double-quotes)
          L14 |  <div bad='' bad=''></div>
                            ^ Duplicate of attribute name [ bad ] was found. (attr-no-duplication)
          L15 |  <div bad='' bad=''></div>
                     ^ The value of attribute [ bad ] must be in double quotes. (attr-value-double-quotes)
          L15 |  <div bad='' bad=''></div>
                            ^ The value of attribute [ bad ] must be in double quotes. (attr-value-double-quotes)
          L15 |  <div bad='' bad=''></div>
                            ^ Duplicate of attribute name [ bad ] was found. (attr-no-duplication)
          L16 |  <div bad='' bad=''></div>
                     ^ The value of attribute [ bad ] must be in double quotes. (attr-value-double-quotes)
          L16 |  <div bad='' bad=''></div>
                            ^ The value of attribute [ bad ] must be in double quotes. (attr-value-double-quotes)
          L16 |  <div bad='' bad=''></div>
                            ^ Duplicate of attribute name [ bad ] was found. (attr-no-duplication)
          L17 |  <div bad='' bad=''></div>
                     ^ The value of attribute [ bad ] must be in double quotes. (attr-value-double-quotes)
          L17 |  <div bad='' bad=''></div>
                            ^ The value of attribute [ bad ] must be in double quotes. (attr-value-double-quotes)
          L17 |  <div bad='' bad=''></div>
                            ^ Duplicate of attribute name [ bad ] was found. (attr-no-duplication)
          L18 |  <div bad='' bad=''></div>
                     ^ The value of attribute [ bad ] must be in double quotes. (attr-value-double-quotes)
          L18 |  <div bad='' bad=''></div>
                            ^ The value of attribute [ bad ] must be in double quotes. (attr-value-double-quotes)
          L18 |  <div bad='' bad=''></div>
                            ^ Duplicate of attribute name [ bad ] was found. (attr-no-duplication)
          L19 |  <div bad='' bad=''></div>
                     ^ The value of attribute [ bad ] must be in double quotes. (attr-value-double-quotes)
          L19 |  <div bad='' bad=''></div>
                            ^ The value of attribute [ bad ] must be in double quotes. (attr-value-double-quotes)
          L19 |  <div bad='' bad=''></div>
                            ^ Duplicate of attribute name [ bad ] was found. (attr-no-duplication)
          L20 |  <div bad='' bad=''></div>
                     ^ The value of attribute [ bad ] must be in double quotes. (attr-value-double-quotes)
          L20 |  <div bad='' bad=''></div>
                            ^ The value of attribute [ bad ] must be in double quotes. (attr-value-double-quotes)
          L20 |  <div bad='' bad=''></div>
                            ^ Duplicate of attribute name [ bad ] was found. (attr-no-duplication)
          L21 |  <div bad='' bad=''></div>
                     ^ The value of attribute [ bad ] must be in double quotes. (attr-value-double-quotes)
          L21 |  <div bad='' bad=''></div>
                            ^ The value of attribute [ bad ] must be in double quotes. (attr-value-double-quotes)
          L21 |  <div bad='' bad=''></div>
                            ^ Duplicate of attribute name [ bad ] was found. (attr-no-duplication)
          L22 |  <div bad='' bad=''></div>
                     ^ The value of attribute [ bad ] must be in double quotes. (attr-value-double-quotes)
          L22 |  <div bad='' bad=''></div>
                            ^ The value of attribute [ bad ] must be in double quotes. (attr-value-double-quotes)
          L22 |  <div bad='' bad=''></div>
                            ^ Duplicate of attribute name [ bad ] was found. (attr-no-duplication)
          L23 |  <div bad='' bad=''></div>
                     ^ The value of attribute [ bad ] must be in double quotes. (attr-value-double-quotes)
          L23 |  <div bad='' bad=''></div>
                            ^ The value of attribute [ bad ] must be in double quotes. (attr-value-double-quotes)
          L23 |  <div bad='' bad=''></div>
                            ^ Duplicate of attribute name [ bad ] was found. (attr-no-duplication)
          L24 |  <div bad='' bad=''></div>
                     ^ The value of attribute [ bad ] must be in double quotes. (attr-value-double-quotes)
          L24 |  <div bad='' bad=''></div>
                            ^ The value of attribute [ bad ] must be in double quotes. (attr-value-double-quotes)
          L24 |  <div bad='' bad=''></div>
                            ^ Duplicate of attribute name [ bad ] was found. (attr-no-duplication)
          L25 |  <input type="text"></input>
                                    ^ Tag must be paired, no start tag: [ </input> ] (tag-pair)
          L26 |  <div class"foo">
                 ^ Special characters must be escaped : [ < ]. (spec-char-escape)
          L26 |  <div class"foo">
                                ^ Special characters must be escaped : [ > ]. (spec-char-escape)
          L28 |          </div>
                         ^ Tag must be paired, no start tag: [ </div> ] (tag-pair)
          L29 |        </div>
                       ^ Tag must be paired, no start tag: [ </div> ] (tag-pair)
          L30 |      </hello>
                     ^ Tag must be paired, no start tag: [ </hello> ] (tag-pair)
          L31 |    </test>
                   ^ Tag must be paired, no start tag: [ </test> ] (tag-pair)
          L32 |  </div>
                 ^ Tag must be paired, no start tag: [ </div> ] (tag-pair)
          L38 |              <div class='' what='' something=''></div>
                                 ^ The value of attribute [ class ] must be in double quotes. (attr-value-double-quotes)
          L38 |              <div class='' what='' something=''></div>
                                          ^ The value of attribute [ what ] must be in double quotes. (attr-value-double-quotes)
          L38 |              <div class='' what='' something=''></div>
                                                  ^ The value of attribute [ something ] must be in double quotes. (attr-value-double-quotes)
          L44 |  </div>
                 ^ Tag must be paired, no start tag: [ </div> ] (tag-pair)
          L50 |              <div class='' what='' something=''></div>
                                 ^ The value of attribute [ class ] must be in double quotes. (attr-value-double-quotes)
          L50 |              <div class='' what='' something=''></div>
                                          ^ The value of attribute [ what ] must be in double quotes. (attr-value-double-quotes)
          L50 |              <div class='' what='' something=''></div>
                                                  ^ The value of attribute [ something ] must be in double quotes. (attr-value-double-quotes)
          L56 |  </div>
                 ^ Tag must be paired, no start tag: [ </div> ] (tag-pair)
          L62 |              <div class='' what='' something=''></div>
                                 ^ The value of attribute [ class ] must be in double quotes. (attr-value-double-quotes)
          L62 |              <div class='' what='' something=''></div>
                                          ^ The value of attribute [ what ] must be in double quotes. (attr-value-double-quotes)
          L62 |              <div class='' what='' something=''></div>
                                                  ^ The value of attribute [ something ] must be in double quotes. (attr-value-double-quotes)
          L68 |  </div>
                 ^ Tag must be paired, no start tag: [ </div> ] (tag-pair)
          L74 |              <div class='' what='' something=''></div>
                                 ^ The value of attribute [ class ] must be in double quotes. (attr-value-double-quotes)
          L74 |              <div class='' what='' something=''></div>
                                          ^ The value of attribute [ what ] must be in double quotes. (attr-value-double-quotes)
          L74 |              <div class='' what='' something=''></div>
                                                  ^ The value of attribute [ something ] must be in double quotes. (attr-value-double-quotes)
          L80 |  </div>
                 ^ Tag must be paired, no start tag: [ </div> ] (tag-pair)
          L81 |</bad>
               ^ Tag must be paired, no start tag: [ </bad> ] (tag-pair)
          L82 |</bad>
               ^ Tag must be paired, no start tag: [ </bad> ] (tag-pair)
          L83 |</bad>
               ^ Tag must be paired, no start tag: [ </bad> ] (tag-pair)
          L84 |</bad>
               ^ Tag must be paired, no start tag: [ </bad> ] (tag-pair)
          L85 |</bad>
               ^ Tag must be paired, no start tag: [ </bad> ] (tag-pair)
          L86 |</bad>
               ^ Tag must be paired, no start tag: [ </bad> ] (tag-pair)
          L87 |</bad>
               ^ Tag must be paired, no start tag: [ </bad> ] (tag-pair)
          L88 |</bad>
               ^ Tag must be paired, no start tag: [ </bad> ] (tag-pair)
          L89 |</bad>
               ^ Tag must be paired, no start tag: [ </bad> ] (tag-pair)
          L90 |</bad>
               ^ Tag must be paired, no start tag: [ </bad> ] (tag-pair)
          L91 |</bad>
               ^ Tag must be paired, no start tag: [ </bad> ] (tag-pair)
          L92 |</bad>
               ^ Tag must be paired, no start tag: [ </bad> ] (tag-pair)
          L93 |</bad>
               ^ Tag must be paired, no start tag: [ </bad> ] (tag-pair)
          L94 |</bad>
               ^ Tag must be paired, no start tag: [ </bad> ] (tag-pair)
          L95 |</bad>
               ^ Tag must be paired, no start tag: [ </bad> ] (tag-pair)
          L96 |</bad>
               ^ Tag must be paired, no start tag: [ </bad> ] (tag-pair)
          L97 |</bad>
               ^ Tag must be paired, no start tag: [ </bad> ] (tag-pair)

    Scanned 1 files, found 92 errors in 1 files (32 ms)