/HTMLHint

A Static Code Analysis Tool for HTML

Primary LanguageJavaScriptMIT LicenseMIT

HTMLHint

HTMLHint logo

HTMLHint is a Static Code Analysis Tool for HTML, you can use it with IDE or in build system.

Build Status Coverage Status NPM version License NPM count NPM count

Official Site: http://htmlhint.com/

Quick start

  1. install & hint

     npm install htmlhint -g
 htmlhint -V
 htmlhint --help
 htmlhint www
 htmlhint www/test.html
 htmlhint www/**/*.xhtml
 htmlhint www/**/*.{htm,html}
 htmlhint http://www.alibaba.com/
 cat test.html | htmlhint stdin

  2. results

        test.html
       L5 |    </head>
               ^ <title> must be present in <head> tag. (title-require)
       L8 |    </body>
               ^ Tag must be paired, missing: [ </div> ], start tag match failed [ <div> ] on line 7. (tag-pair)

 2 errors in 1 files

  3. config rules

    search .htmlhintrc file in current directory and all parent directories:

     htmlhint
 htmlhint test.html

    custom config file:

     htmlhint --config htmlhint.conf test.html

    custom rules:

     htmlhint --rules tag-pair,id-class-value=underline test.html

    Inline rules in test.html:

     <!--htmlhint tag-pair,id-class-value:underline -->
 <html>
 <head>
     ...

Guide

  1. How to use
  2. All Rules
  3. How to Develop

License

HTMLHint is released under the MIT license:

The MIT License

Copyright (c) 2014-2016 Yanis Wang < yanis.wang@gmail.com >

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Thanks