Skip to content
💡 A hinting engine for the web
TypeScript JavaScript CSS HTML
Branch: master
Clone or download
Pull request Compare This branch is 1 commit ahead, 49 commits behind webhintio:master.
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
.github
.vscode
@types
azure-pipelines
packages
release
scripts
.editorconfig
.eslintignore
.eslintrc.json
.gitattributes
.gitignore
.markdownlintrc
.npmrc
.nycrc
CODE_OF_CONDUCT.md
LICENSE.txt
README.md
azure-pipelines.yml
package.json
tsconfig.json
yarn.lock

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 to test it.

Testing with npx

Run the following command:

npx hint https://example.com

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

Installing webhint locally

Install webhint as a devDependency of your project:

npm install hint --save-dev

And then add a script task to your package.json:

{
    ...
    "scripts": {
        "webhint": "hint"
    }
}

And run it via:

npm run webhint -- http://localhost:8080

Or if you are using yarn you can skip the step to create a task and run directly:

yarn hint http://localhost:8080

To know more about webhint, how to configure it, etc. see the online user guide, or the local version for the most recent 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.