This site uses cookies for analytics. By continuing to browse this site, you agree to this use.
A JS Foundation Project

User guide

User guide

Getting started

If you want to have an idea of what webhint does and you have an updated version of npm (v5.2.0) and Node LTS (v8.9.2) or later you can use the following command:

npx hint https://example.com

Alternatively, you can install it locally with:

npm install -g --engine-strict hint

You can also install it as a devDependency if you prefer not to have it globally (which is the team’s preferred option).

The next thing that webhint needs is a .hintrc file. By default, webhint will look for this file first in the current folder and then in the user’s home directory.

The fastest and easiest way to create one is by running:

npm create hintrc

This command will start a wizard that will ask you a series of questions (e.g.: do you want to use a predefined configuration or prefer to create one with the installed resource, what connector to use, formatter, hints, etc.). Answer them and you will end up with something similar to the following if you decided to use a predefined configuration:

{
"extends": ["configurationName"]
}

or the following if custom:

{
"connector": {
"name": "connectorName"
},
"formatters": ["formatterName"],
"hints": {
"hint1": "error",
"hint2": "warning",
"hint3": "off"
},
"hintsTimeout": 120000
...
}

Then you have to run the following command to scan a website:

hint https://example.com

Wait a few seconds and you will get something similar to the following:

Example output for the summary formatter

It might take a few minutes to get some of the results. Some of the hints (e.g.: SSL Labs) can take a few minutes to report the results.

Default configuration

To run webhint you need a .hintrc file. If you do not have one, webhint will use the web-recommended set of hints. This configuration will be equivalent to the following .hintrc:

{
"extends": ["web-recommended"]
}

Further reading

Now that you have webhint up and running, it is time to learn a bit more about the different pieces:

Windows and Python

Depending on your environment you could get an error similar to the following if there is a problem downloading any of the precompiled native modules:

gyp ERR! stack Error: Can’t find Python executable “python”

The fastest way to have a Windows environment capable of compiling native Node modules is installing the windows-build-tools.

From an Elevated PowerShell run the following:

npm install --global windows-build-tools

Permission issues during installation

If you receive an EACCES error when installing webhint, it is caused by installing packages globally. The recommended solution is to change npm’s default directory and then try again. There have been reports of this issue when installing the dependency canvas-prebuilt throws an EACCES. This issue was resolved adopting the recommended solution. You can find detailed steps on how to change the npm default directory here. According to npm’s documentation, if you have node installed using a package manager like Homebrew or nvm, you may be able to avoid the trouble of messing with the directories and have the correct permissions set up right out of the box. As a result, you will not experience the error described above even if you install webhint globally.