💡 A hinting engine for the web
Clone or download
Latest commit 59ad752 Jan 16, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Chore: Remove `@alrra` from `CODEOWNERS` Jan 14, 2019
.travis Chore: Replace ESLint `no-unused-vars` Oct 24, 2018
@types Chore: Enable strict type-checking Oct 9, 2018
azure-pipelines Build: Tweak Azure Pipelines configuration Jan 15, 2019
packages Chore: Add note about supported versions Jan 17, 2019
scripts Build: Remove ] Jan 17, 2019
.editorconfig Chore: Use HTTPS for editorconfig.org URL May 30, 2018
.eslintignore Chore: Update dependencies and devDependencies Nov 10, 2018
.eslintrc.json Chore: Linting errors with latest `eslint-typescript-parser` Nov 5, 2018
.gitattributes Chore: Make Git checkout files with LF endings Sep 11, 2018
.gitignore Chore: Update to `v1.0.4` Nov 27, 2018
.markdownlintrc Docs: Fix reference links and remove `markdownlint-cli` dependency (#… Dec 4, 2018
.npmrc Chore: Prevent npm from creating package-lock.json Mar 7, 2018
.nycrc Chore: Decrease coverage values Mar 6, 2018
.travis.yml Build: Disable website deploy Jan 15, 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 Chore: Add FOSSA Jan 10, 2019
azure-pipelines.yml Build: Tweak Azure Pipelines configuration Jan 15, 2019
greenkeeper.json Chore: Move ignored packages to `greenkeeper.json` Nov 13, 2018
package.json Build: Make release script auto-retry tests if they fail Jan 15, 2019
tsconfig.json Chore: Add `parser-package-json` reference in `tsconfig.json` Jan 8, 2019
yarn.lock Chore: Update `yarn.lock` file Jan 16, 2019

README.md

webhint

Travis CI build status Greenkeeper status Gitter FOSSA Status

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 sepreated 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