Simple node app to run accessibility tests with axe-core and @axe-core/puppeteer
Install dependencies using yarn
command.
- Run
yarn axe:configure
command - it will createresultsDir
(by defaultaxe-results
) and custom config file -axe.config.json
in root of your working directory - Provide urls to
pages
array in your custom config files or pass urls using command line arguments.
resultsDir
is required to save tests results.
If you change resultsDor
value in config file, run yarn axe:configure
to create a directory.
create axe.config.json
in your and add options:
required options:
list of urls to test
Create axe.config.json
in your module.
add urls which you want to test in pages
array and use available options to overwrite defaults.
Start testing:
yarn axe:test
{
"pages": [],
"fileName": "tested-file",
"resultsDir": "axe-results",
"basicAuth": null,
"axeConfig": {
"reporter": "v2"
},
"viewport": {
"width": "1920",
"height": "1080"
}
}
basicAuth: {
username: 'some username',
password: 'some passworg'
}
Config hierarchy:
- custom config
- default config
Configs objects are merged.
The project is WIP