htmlhint
htmlhint documentation
- Version in MegaLinter: 1.1.4
- Visit Official Web Site
- See How to configure htmlhint rules
- If custom
.htmlhintrc
config file isn't found, .htmlhintrc will be used
- If custom
- See How to disable htmlhint rules in files
- See Index of problems detected by htmlhint
Configuration in MegaLinter
- Enable htmlhint by adding
HTML_HTMLHINT
in ENABLE_LINTERS variable - Disable htmlhint by adding
HTML_HTMLHINT
in DISABLE_LINTERS variable
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 filesEx: [".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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling HTML_HTMLHINT and its pre/post commands | None |
HTML_HTMLHINT_CONFIG_FILE | htmlhint configuration file nameUse 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 |
HTML_HTMLHINT_CLI_EXECUTABLE | Override CLI executable | ['htmlhint'] |
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 |
MegaLinter Flavours
This linter is available in the following flavours
Flavor | Description | Embedded linters | Info | |
---|---|---|---|---|
all | Default MegaLinter Flavor | 113 | ||
cupcake | MegaLinter for the most commonly used languages | 81 | ||
documentation | MegaLinter for documentation projects | 47 | ||
dotnet | Optimized for C, C++, C# or VB based projects | 59 | ||
go | Optimized for GO based projects | 49 | ||
java | Optimized for JAVA based projects | 51 | ||
javascript | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 56 | ||
php | Optimized for PHP based projects | 50 | ||
python | Optimized for PYTHON based projects | 58 | ||
ruby | Optimized for RUBY based projects | 47 | ||
rust | Optimized for RUST based projects | 47 | ||
salesforce | Optimized for Salesforce based projects | 50 | ||
swift | Optimized for SWIFT based projects | 47 | ||
terraform | Optimized for TERRAFORM based projects | 51 |
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 (
list_of_files
CLI lint mode)
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
- NPM packages (node.js):