Nightwatch Axe


Nightwatch.js custom commands for aXe.

Install

Install using yarn or npm

``bash
yarn add nightwatch-axe
`

Update your nightwatch config file with new paths to command and assertion files

`js
{
custom_commands_path : [
"./node_modules/nightwatch-axe/src/commands"
]
}
`

aXe Commands

#### axeInject()

Injects the axe-core js library into your test page

`js
export default {
'@tags': ['accessibility'],

'Page Is Accessible'(browser) {
...

browser.axeInject()
}
}
`

#### axeRun(options)

Analyzes the current page against applied axe rules

Parameter Name | Parameter Type | Description
------------- | -------------- | -----------
selector | string | css selector to area under test
options | object | set of axe options

`js
export default {
'@tags': ['accessibility'],

'Page Is Accessible'(browser) {
...

browser.axeInject()
browser.axeRun('#main', {
rules: {
'color-contrast': { enabled: false }
}
})
}
}
``