@hint/configuration-accessibility

webhint's axe-based accessibility configuration for WCAG 2.1 Level A and Level AA requirements

Usage no npm install needed!

<script type="module">
  import hintConfigurationAccessibility from 'https://cdn.skypack.dev/@hint/configuration-accessibility';
</script>

README

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 and it is installed automatically with webhint:

npm install hint --save-dev

Note: The recommended way of running webhint is as a devDependency of your project.

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"]
}