Lints an HTML5 file using Google's style guide
HTML Linter is an HTML5 linter that follows the style guide defined by Google.
Handling HTML5 files generated by lots of different of people is a difficult task, because the standard is evolving quite fast and also because browsers are quite open to accept any malformed/invalid/incomplete input.
That’s why we decided to have an automated tool to check our coding standard.
The list of extra rules we added are:
- Boolean attributes should not have an explicit value.
- Do not use the name attribute in a tags.
- Do not use the language attribute in script tags.
- Do not use the charset attribute in script tags when there is no source.
- meta http-equiv: use only standard properties + X-UA-compatible
- No extra white-spaces between attributes or before the opening or closing tag.
What is missing?
Check if the file has BOM.
The ability to validate the HTML using the tool HTML5 tidy and to integrate some schema.org or microdata validator.
However, we do not have any short terms plans to handle the latter, due to a couple of reasons:
html_linter used the project template-remover to remove the PHP and Jinja markup from the files and this project works has some limitations.
One example that won’t work is the following:
<?php echo "?>" ?>
The reason it does not work is because when the method sees the first ‘?>’ (the one inside the string), it thinks it’s a closing tag.
Below are example of how template_remover.py is used:
$ html_lint.py filename.html
You can install, upgrade or uninstall html-linter with these commands:
$ pip install html-linter $ pip install --upgrade html-linter $ pip uninstall html-linter
Python 2.7, 3.3, 3.4, 3.5 and 3.6 are supported.
Help for this project is more than welcomed, so feel free to create an issue or to send a pull request via http://github.com/deezer/html-linter.
Tests are run using nose, either with:
$ python -R setup.py nosetests $ nosetests
Use the tool git-lint before any commit, so errors and style problems are caught early.
TODOS and Possible Features
- Make the output less verbose.
- Integrate with HTML5 tidy.
- Integrate with a schema.org/microdata validator.