Skip to content
💡 A hinting engine for the web
TypeScript JavaScript CSS HTML
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.dependabot Chore: Re-enable automerged updates Jul 11, 2019
.github Fix: Pre-populate known environment data when clicking "Feedback" Aug 5, 2019
.vscode Build: Release improvements May 21, 2019
@types Chore: Enable strict type-checking Oct 9, 2018
azure-pipelines Build: Re-enable using node 12.x instead of 11.x in CI Aug 7, 2019
packages Upgrade: Bump @types/express from 4.17.0 to 4.17.1 Aug 19, 2019
release Fix: Add configurations to configuration-all Aug 15, 2019
scripts Breaking: Use __dirname to find the locale file. Aug 12, 2019
.editorconfig Build: Disable `Travis CI` Jan 18, 2019
.eslintignore Fix: Prune UserConfig data Aug 2, 2019
.eslintrc.json Chore: Fully migrate to `@typescript-eslint/eslint-plugin|parser` Feb 9, 2019
.gitattributes Chore: Avoid normalizing binary files Feb 7, 2019
.gitignore New: Make CLI, hints, and formatters localizable Jul 18, 2019
.markdownlintrc Docs: Fix reference links and remove `markdownlint-cli` dependency (#… Dec 4, 2018
.npmrc Build: Avoid possible warnings when using `nvm` Apr 12, 2019
.nycrc Build: Fix code coverage report May 7, 2019
CODE_OF_CONDUCT.md Build: Optimize testing process Jul 13, 2018
LICENSE.txt Update copyright to standard JSF statement Jun 20, 2017
README.md Docs: Update readme and docs with missing information Aug 2, 2019
azure-pipelines.yml Build: Tweak Azure Pipelines configuration Jan 15, 2019
package.json Fix: Pre-populate known environment data when clicking "Feedback" Aug 5, 2019
tsconfig.json New: Add hint to validate display attribute of summary tag Jul 11, 2019
yarn.lock Upgrade: Bump @types/express from 4.17.0 to 4.17.1 Aug 19, 2019

README.md

webhint

Build Status Gitter FOSSA Status

Quick start user guide

Once you have Node.js (v8.x or later) 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

Choose configurations:

❯ predefined
  custom

Choose the configuration you want to extend from:

❯ development
  web-recommended
  progressive-web-apps

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.

FOSSA Status

You can’t perform that action at this time.