Instructions for WebdriverIO and JavaScript

In the root level of your testing folder, install the @axe-core/watcher package and all of its dependencies using npm or your preferred package manager (for example, yarn or pnpm).

npm install --save-dev @axe-core/watcher

In your test files, import the wdioConfig() function, the wrapWdio() function, and the WdioController class from @axe-core/watcher/wdio:

const {
  wdioConfig,
  wrapWdio,
  WdioController
} = require('@axe-core/watcher/wdio')

In your test setup code (typically in a before or beforeAll block), wrap any existing code for creating a browser instance with a call to wdioConfig(), while providing your API key:

const ACCESSIBILITY_API_KEY = process.env.ACCESSIBILITY_API_KEY
const PROJECT_ID = process.env.PROJECT_ID

const browser = await wdio.remote(
  wdioConfig({
    axe: {
      apiKey: ACCESSIBILITY_API_KEY,
      projectId: PROJECT_ID
    }
  })
)

Be sure to set ACCESSIBILITY_API_KEY and PROJECT_ID in your environment to your personal API key (found in your axe Account, API KEYS tab) and your project ID (shown at the top of these instructions when you created your project or available from the Projects page by choosing Configure project under Settings).

Once you have a browser instance, create an instance of the WdioController class:

const controller = new WdioController(browser)

Wrap your browser instance with the wrapWdio() function, providing the browser instance and the controller instance:

wrapWdio(browser, controller)

Finally, ensure all test results from axe Watcher are flushed out. To do this, add the following block of code to your test teardown code (typically in an afterEach block):

afterEach(async () => {
  await controller.flush()
})