This site uses cookies for analytics. By continuing to browse this site, you agree to this use.

webhint's accessibility configuration

webhint’s accessibility configuration (@hint/configuration-accessibility)

This is a webhint configuration package to use for enabling accessibility hints based on axe-core provided via hint-axe.

This package will automatically install all the missing dependencies.

To use it you will have to install it via npm:

npm install @hint/configuration-accessibility

Note: You can make npm install it as a devDependency using the --save-dev parameter, or to install it globally, you can use the -g parameter. For other options see npm‘s documentation.

The minimum required .hintrc file to use it is the following:

{
    "extends": ["accessibility"]
}

and it will be as if you had this:

{
    "connector": "puppeteer",
    "formatters": [
        "html",
        "summary"
    ],
    "hints": {
        "axe/aria": "error",
        "axe/color": "error",
        "axe/forms": "error",
        ...
    },
    "hintsTimeout": 120000
}

If you prefer to use another formatter (or any other hint/connector, etc.) you can do something like:

{
    "extends": ["accessibility"],
    "formatters": ["codeframe"]
}