@doodle/a11ytester

This library provides a small framework to test the accessibility of a frontend project.

Install

echo registry=https://npm-proxy.fury.io/mfsTqYdDz3bsKFQJuMAR/tmf/ >> .npmrc
yarn add --dev --save-exact @doodle/a11ytester

Contribute

You will need Node 8 to start this application

Install the dependencies

yarn

Test

Run the unit tests

yarn test

Configuration

The module can be configured in the package.json using an object property called a11ytester.

Example:

{
  "reportsPath": "dist/a11y-reports",
  "pa11y": {
    "timeout": 60000,
    "chromeLaunchConfig": {
      "headless": false
    },
  }
}

Valid properties

• reportsPath: the folder where file reports will be saved
• verbose: prints more information in the terminal
• pa11y: the configuration passed to pa11y

Valid pa11y properties

https://github.com/pa11y/pa11y#configuration

Puppeteer properties for pa11y (pa11y.chromeLaunchConfig)

https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#puppeteerlaunchoptions

Writing a11y specs

See the docs.