GithubHelp home page GithubHelp logo

htmlhint-ng2's Introduction

HTMLHint-ng2

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

It extends https://github.com/yaniswang/HTMLHint and adds support for Angular 2 attributes ie, [inputs], (outputs), *ngDirectives, and includes rules supporting camelCase attribute names and preventing inline attributes for better diff-ing.

NPM version License NPM count NPM count

Quick start

  1. install & hint

     npm install htmlhint-ng2 -g
     htmlhint-ng2 -V
     htmlhint-ng2 --help
     htmlhint-ng2 www
     htmlhint-ng2 www/test.html
     htmlhint-ng2 www/**/*.xhtml
     htmlhint-ng2 www/**/*.{htm,html}
    
  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>
         ...
    

License

HTMLHint-ng2 is released under the MIT license:

The MIT License

Copyright (c) 2014-2015 Yanis Wang < [email protected] >

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

htmlhint-ng2's People

Contributors

nikolasleblanc avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

ccadieux h-4vok

htmlhint-ng2's Issues

does not work out of the box.

angular2 CLI project, all angular attributes show as errors.

what rule changes are needed to make your stuff work?

Package vulnerabilities warning

Hey, I see you are not quite active but thought of still leaving a comment.

Your tool is great and we use it everyday to lint our HTML on an Angular 7.3.6 project.

However, npm is identifying vulnerabilities in your package. Now, these do not really matter much as htmlhint-ng2 is supposed to be a devDependency anyway, but it would be nice to sort those out.

Here is the npm audit output:

                       === npm audit security report ===


                                 Manual Review
             Some vulnerabilities require your attention to resolve

          Visit https://go.npm.me/audit-guide for additional guidance


  Low             Arbitrary File Write

  Package         cli

  Patched in      >=1.0.0

  Dependency of   htmlhint-ng2 [dev]

  Path            htmlhint-ng2 > jshint > cli

  More info       https://npmjs.com/advisories/95


  High            Regular Expression Denial of Service

  Package         minimatch

  Patched in      >=3.0.2

  Dependency of   htmlhint-ng2 [dev]

  Path            htmlhint-ng2 > jshint > cli > glob > minimatch

  More info       https://npmjs.com/advisories/118


  High            Regular Expression Denial of Service

  Package         minimatch

  Patched in      >=3.0.2

  Dependency of   htmlhint-ng2 [dev]

  Path            htmlhint-ng2 > jshint > minimatch

  More info       https://npmjs.com/advisories/118


  Low             Prototype Pollution

  Package         lodash

  Patched in      >=4.17.5

  Dependency of   htmlhint-ng2 [dev]

  Path            htmlhint-ng2 > jshint > lodash

  More info       https://npmjs.com/advisories/577


  High            Prototype Pollution

  Package         lodash

  Patched in      >=4.17.11

  Dependency of   htmlhint-ng2 [dev]

  Path            htmlhint-ng2 > jshint > lodash

  More info       https://npmjs.com/advisories/782


  High            Prototype Pollution

  Package         lodash

  Patched in      >=4.17.12

  Dependency of   htmlhint-ng2 [dev]

  Path            htmlhint-ng2 > jshint > lodash

  More info       https://npmjs.com/advisories/1065

Probably all you need is npm audit fix on your side ?? Maybe I'll take the time to fork it and give it a try myself. If you are able to fix this one that'd be great for automation and warning-clean addicts like me!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.