HTMLHint

The static code analysis tool you need for your HTML.

  How To Use • Contributing • Website

Table of Contents

- Installation and Usage
- Local Installation and Usage
- Global Installation and Usage
- Example output
- Configuration
- Docs

📟 Installation and Usage

There are two ways to install HTMLHint: globally and locally.

$3

In case you want to include HTMLHint as part of your project, you can install it locally using npm:

``bash
npm install htmlhint --save-dev
`

After that, You can run HTMLHint on any file or directory like this:

`bash
./node_modules/.bin/htmlhint www/index.html
./node_modules/.bin/htmlhint www/*/.html
`

Or, you can use HTMLHint linter programmatically, like this:

`js
import { HTMLHint } from 'htmlhint'
const htmlVerificationHints = HTMLHint.verify(localHtmlContent)
console.log('htmlVerificationHints', htmlVerificationHints) // this logs a list of Hints which contain information on all linting errors
`

$3

If you want to make HTMLHint available to tools that run across all of your projects, you can install HTMLHint globally using npm:

`bash
npm install htmlhint -g
`

After that, you can run HTMLHint on any file like this:

`bash
htmlhint www/index.html
htmlhint www/*/.html
`

You can even launch HTMLHint to analyze an URL:

`bash
htmlhint https://htmlhint.com/
`

📃 Example output

🔧 Configuration

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

`bash
htmlhint
htmlhint test.html
`

Custom config file:

`bash
htmlhint --config htmlhint.conf test.html
`

Custom rules:

`bash
htmlhint --rules tag-pair,id-class-value=underline index.html
`

Inline rules in test.html:

`html



...


``

📙 Docs

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

© License

MIT License

💪🏻 Contributors

This project exists thanks to all these people. Contribute.

🏅 Backers

Thank you to all our backers! Become a backer.

🎖 Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. Become a sponsor.