webhint (hint
)
Quick start user guide
Once you have Node.js
v8.x on your machine, you can use npx
or install webhint
globally
to use it.
Using npx
Run the following command:
npx hint https://example.com
This will start the wizard to create a .hintrc
file, and then
analyze https://example.com
.
Windows users: Currently npx
has an issue in this
platform.
Installing webhint
globally
npm install -g --engine-strict hint
Create a .hintrc
file by running this command and following the
instructions:
hint --init
Scan a website:
hint https://example.com
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 hint
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.