designtips / hint

💡 A hinting engine for the web

webhint

Quick start user guide

Once you have Node.js v8.x on your machine, you can use npx or install hint globally to use it.

Using npx

Run the following command:

npx hint https://example.com

This will analyze https://example.com using the default configuration.

Installing webhint globally

npm install -g --engine-strict hint

Create a .hintrc file by running this command and following the instructions:

npm create hintrc

Scan a website:

hint https://example.com

To use a different formatter than the one specified in your .hintrc file you can do the following:

hint https://example.com --formatters excel

To use a different hint than the one specified in your .hintrc file:

hint https://example.com --hints html-checker

Multiple hints can be specified as a comma separated string:

hint https://example.com --hints axe,html-checker

For more in depth information on how to get started, configurations, and more, see the online user guide, or the local version for the most recent (and unstable) content.

Contributing to webhint

To know more about the internals of webhint, the structure of the project, how to create new hints, collectors, formatters, etc, take a look at the online contributor guide (or the local version).

Code of Conduct

This project adheres to the JS Foundation’s code of conduct. By participating in this project you agree to abide by its terms.

License

The code is available under the Apache 2.0 license.