webhint

A hinting engine for the web

LinterAccessibility
webhintio/hintwebhint.io/hint

README

webhint

Build Status Gitter FOSSA Status

Quick start user guide


webhint is a customizable linting tool that helps you improve your site's
accessibility, speed, cross-browser compatibility, and more by checking your
code for best practices and common errors.

It can be run from the command line (CLI), via a [browser extension][], as a
[VS Code extension][], and from the [online service][].

To use it from the from the CLI you will need to install [Node.js][node]
(v10.x or later) on your machine, and you can use [npx][npx] to test it.

Testing with npx


Run the following command:

  1. ``` sh
  2. npx hint https://example.com
  3. ```

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

Installing webhint locally


Install webhint as a devDependency of your project:

  1. ``` sh
  2. npm install hint --save-dev
  3. ```

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

  1. ``` json
  2. {
  3.     ...
  4.     "scripts": {
  5.         "webhint": "hint"
  6.     }
  7. }
  8. ```

And run it via:

  1. ``` sh
  2. npm run webhint -- http://localhost:8080
  3. ```

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

  1. ``` sh
  2. yarn hint http://localhost:8080
  3. ```

To know more about webhint, how to configure it, etc. see the online
[user guide][user guide], or the [local version][local user guide]
for the most recent content.

Contributing to webhint


This project follows a monorepo pattern. That means that the code
for all the webhint flavors (CLI, browser and VS Code extension,
hints, formatters, etc.) are in here and are published as separate
npm packages.

To build the project from the source you will need to install
a recent version of node and [yarn][]. Once you've done this run
the following from the root of your cloned version:

  1. ``` sh
  2. yarn
  3. yarn build
  4. ```

This can take a bit so please be patient.

To learn more about the internals of webhint, the structure of the
project, how to create new hints, parsers, formatters, etc, take
a look at the online [contributor guide][contributor guide] (or the
[local version][local contributor guide]).

Contributing to the browser and VS Code extensions


To learn about how to build one of the extensions please check
the CONTRIBUTING.md files for each of these packages:

[packages/extension-browser/CONTRIBUTING.md][contrib browser]
  for the browser extension.
[packages/extension-vscode/CONTRIBUTING.md][contrib vscode]
  for the VS Code extension.

Code of Conduct


All projects in the webhintio organization follow this [CoC][coc]
which adheres to the [OpenJS Foundation Code of Conduct][ojs coc].

Other important links


[Charter][]
[Governance][]

License


The code is available under the [Apache 2.0 license][license].
FOSSA Status



[browser extension]: https://webhint.io/docs/user-guide/extensions/extension-browser/
[charter]: ./packages/hint/docs/about/PROJECT_CHARTER-draft.md
[coc]: https://github.com/webhintio/.github/blob/master/CODE_OF_CONDUCT
[contrib browser]: ./packages/extension-browser/CONTRIBUTING.md
[contrib vscode]: ./packages/extension-vscode/CONTRIBUTING.md
[contributor guide]: https://webhint.io/docs/contributor-guide/
[Governance]: ./packages/hint/docs/about/GOVERNANCE-draft.md
[license]: LICENSE.txt
[local contributor guide]: ./packages/hint/docs/contributor-guide/index.md
[local user guide]: ./packages/hint/docs/user-guide/index.md
[node]: https://nodejs.org/en/download/current/
[npx]: https://github.com/zkat/npx
[ojs coc]: https://github.com/openjs-foundation/cross-project-council/blob/master/CODE_OF_CONDUCT.md
[online service]: https://webhint.io/scanner/
[user guide]: https://webhint.io/docs/user-guide/
[VS Code extension]: https://webhint.io/docs/user-guide/extensions/vscode-webhint/
[yarn]: http://yarnpkg.com/