Skip to content
💡 A hinting engine for the web
TypeScript JavaScript CSS HTML
Branch: master
Clone or download
dependabot-preview Upgrade: Bump mdn-browser-compat-data from 0.0.95 to 0.0.96
Bumps [mdn-browser-compat-data](https://github.com/mdn/browser-compat-data) from 0.0.95 to 0.0.96.
- [Release notes](https://github.com/mdn/browser-compat-data/releases)
- [Commits](mdn/browser-compat-data@v0.0.95...v0.0.96)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
Latest commit cdaa672 Oct 12, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.dependabot Chore: Re-enable automerged updates Jul 11, 2019
.github Chore: Add utsavized as a code owner Sep 5, 2019
.vscode Build: Recommend EditorConfig extension in VS Code Sep 17, 2019
@types Chore: Enable strict type-checking Oct 9, 2018
azure-pipelines Build: Improve build times by storing artifacts Oct 8, 2019
packages Upgrade: Bump mdn-browser-compat-data from 0.0.95 to 0.0.96 Oct 12, 2019
release Build: Fix issue wrapping errors Sep 24, 2019
scripts Build: Improve build times by storing artifacts Oct 8, 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 Build: Disable unnecessary markdownlint rule Oct 7, 2019
.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: Improve information for contributors Oct 9, 2019
azure-pipelines.yml Build: Tweak Azure Pipelines configuration Jan 15, 2019
package.json Upgrade: Bump execa from 2.0.4 to 2.1.0 Oct 12, 2019
tsconfig.json Fix: Deprecate `connector-chrome` Sep 14, 2019
yarn.lock Upgrade: Bump mdn-browser-compat-data from 0.0.95 to 0.0.96 Oct 12, 2019

README.md

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 (v10.x or later) on your machine, and 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

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:

yarn
yarn build

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 (or the local version).

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:

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.