@dotcom-tool-kit/pa11y [DEPRECATED]
A plugin to run Pa11y accessibility tests. This plugin uses Pa11y CI to run the tests.
Deprecation warning (04/10/2023)
Customer Products no longer recommends using Pa11y for Accessibility testing. This package will be deleted by the end of the year (CPP-1719). We suggest flowing the Accessibility Guidance in Tech Hub to setup Accessibility testing.
Read more about this decision here: https://financialtimes.atlassian.net/wiki/spaces/CPP/blog/2023/10/04/8161493012/Deprecation+of+Pa11y+in+Customer+Products
Installation
With Tool Kit already set up, install this plugin as a dev dependency:
npm install --save-dev @dotcom-tool-kit/pa11y
And add it to your repo's .toolkitrc.yml
:
plugins:
- '@dotcom-tool-kit/pa11y'
Options
Key | Description | Default value |
---|---|---|
configFile |
Path to the config file | .pa11yci.js |
Tasks
Task | Description | Preconfigured hook |
---|---|---|
Pa11y |
runs pa11y-ci to execute Pa11y tests |
test:local |
To note
This plugin will define process.env.TEST_URL
with the Heroku review app URL which can be used in your Pa11y CI config file.