https://github.com/htmlhint/HTMLHint
⚙️ The static code analysis tool you need for your HTML
https://github.com/htmlhint/HTMLHint
analysis code-analysis code-quality hint html htmlhint javascript
Last synced: about 1 year ago
JSON representation
⚙️ The static code analysis tool you need for your HTML
- Host: GitHub
- URL: https://github.com/htmlhint/HTMLHint
- Owner: htmlhint
- License: mit
- Created: 2013-02-24T04:57:55.000Z (about 13 years ago)
- Default Branch: master
- Last Pushed: 2025-03-11T00:22:49.000Z (about 1 year ago)
- Last Synced: 2025-03-11T06:50:52.477Z (about 1 year ago)
- Topics: analysis, code-analysis, code-quality, hint, html, htmlhint, javascript
- Language: JavaScript
- Homepage: https://htmlhint.com
- Size: 11.5 MB
- Stars: 3,116
- Watchers: 76
- Forks: 395
- Open Issues: 57
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
- fucking-awesome-readme - htmlhint/HTMLHint - Centered hero animation as the masthead. Concise tagline. Useful badges (npm version, OpenSSF best practices, downloads, license). Quick navigation links. Table of contents. Sectioned installation guide for local and global use, with both ESM and CommonJS code samples. (Examples)
- awesome-readme - htmlhint/HTMLHint - Centered hero animation as the masthead. Concise tagline. Useful badges (npm version, OpenSSF best practices, downloads, license). Quick navigation links. Table of contents. Sectioned installation guide for local and global use, with both ESM and CommonJS code samples. (Examples)
README
HTMLHint
The static code analysis tool you need for your HTML.
How To Use • Contributing • Website
## Table of Contents
- **[Installation and Usage](#-installation-and-usage)**
- **[Local Installation and Usage](#local-installation-and-usage)**
- **[Global Installation and Usage](#global-installation-and-usage)**
- **[Example output](#-example-output)**
- **[Configuration](#-configuration)**
- **[Docs](#-docs)**
## 📟 Installation and Usage
There are two ways to install HTMLHint: globally and locally.
### Local Installation and Usage
In case you want to include HTMLHint as part of your project, you can install it locally using npm:
```
$ npm install htmlhint --save-dev
```
After that, You can run HTMLHint on any file or directory like this:
```
$ ./node_modules/.bin/htmlhint www/index.html
$ ./node_modules/.bin/htmlhint www/**/*.html
```
### Global Installation and Usage
If you want to make HTMLHint available to tools that run across all of your projects, you can install HTMLHint globally using npm:
```
$ npm install htmlhint -g
```
After that, you can run HTMLHint on any file like this:
```
$ htmlhint www/index.html
$ htmlhint www/**/*.html
```
You can even launch HTMLHint to analyze an URL:
```
$ htmlhint https://htmlhint.com/
```
## 📃 Example output
## 🔧 Configuration
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 index.html
```
Inline rules in `test.html`:
```html
...
```
## 📙 Docs
1. [How to use](https://htmlhint.com/docs/user-guide/usage/cli)
2. [All Rules](https://htmlhint.com/docs/user-guide/list-rules)
3. [How to Develop](CONTRIBUTING.md)
## © License
[MIT License](./LICENSE.md)
## 💪🏻 Contributors
This project exists thanks to all these people. [Contribute](CONTRIBUTING.md).
## 🏅 Backers
Thank you to all our backers! [Become a backer](https://opencollective.com/htmlhint#backer).
## 🎖 Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor](https://opencollective.com/htmlhint#sponsor).
