Instructions for Playwright Test and TypeScript

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

Create a fixtures.ts file alongside your existing Playwright Test tests. In this file, import the playwrightTest() function from @axe-core/watcher:

import { playwrightTest } from '@axe-core/watcher/playwright-test'

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

const { test, expect } = playwrightTest({
  axe: {
    apiKey: ACCESSIBILITY_API_KEY,
    projectId: PROJECT_ID
  },
  headless: false
  // Any other Playwright configuration you’d pass to chromium.launchPersistentContext() here
})

export { test, expect }

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).

In your test files, replace the imports for test and expect from Playwright Test with your fixtures.ts file:

import { test, expect } from '@playwright/test'

// Becomes:
import { test, expect } from './fixtures';

You're all done.