Instrucciones para Playwright y TypeScript

En el nivel raíz de tu carpeta de pruebas, instala el paquete @axe-core/watcher y todas sus dependencias usando npm o tu gestor de paquetes preferido (por ejemplo, yarn o pnpm).

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

En tu archivo o archivos de prueba, importa la función playwrightConfig(), la función wrapPlaywright() y la clase PlaywrightController de @axe-core/watcher/playwright:

import {
  wrapPlaywrightPage,
  playwrightConfig,
  PlaywrightController
} from '@axe-core/watcher/playwright';

En el código de configuración de tus pruebas (típicamente en un bloque before o beforeAll), envuelve cualquier código existente para crear una instancia de browserContext con una llamada a playwrightConfig() proporcionando tu clave API:

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

const browserContext: BrowserContext = await chromium.launchPersistentContext(
  /**
   * We set userDataDir to an empty string which saves
   * browser data to a temporary directory
   * @see https://playwright.dev/docs/api/class-browsertype#browser-type-launch-persistent-context
   */
  '',
  playwrightConfig({
    axe: {
      apiKey: ACCESSIBILITY_API_KEY,
      projectId: PROJECT_ID,
      serverURL: SERVER_URL
    },
    /**
     * We support both headless and headed mode with Chrome.
     * 
     * For headless mode:
     * - Use '--headless=chrome' for browsers v94-108.
     * - Use '--headless=new' for browsers v109+.
     * 
     * For headed mode:
     * - Remove the '--headless' flag.
     * 
     * @see https://playwright.dev/docs/chrome-extensions#headless-mode
     */
    headless: false,
    args: ['--headless=new']
  })
);

Asegúrese de configurar ACCESSIBILITY_API_KEY y PROJECT_ID en su entorno con su clave API personal (que se encuentra en su cuenta de axe, pestaña API KEYS) y su ID de proyecto (mostrado en la parte superior de estas instrucciones cuando creó su proyecto o disponible en la página de Proyectos eligiendo Configurar proyecto bajo Configuración). Si su organización utiliza una instancia regional, nube privada o local de Axe Developer Hub, configure también SERVER_URL con la URL base de esa instancia (por ejemplo, https://axe-eu.deque.com); de lo contrario, omita SERVER_URL y se usará el https://axe.deque.com predeterminado.

Una vez que tengas una instancia de page, crea una instancia de la clase PlaywrightController y envuelve tu browserContext:

// Create a page instance, using your browser context.
let page = await browserContext.newPage();

// Initialize the PlaywrightController by passing in the Playwright page.
const controller = new PlaywrightController(page);

// Use the new wrapped Playwright page instance.
page = wrapPlaywrightPage(page, controller);

Finalmente, asegúrate de que todos los resultados de las pruebas de axe Watcher se descarguen. Para hacer esto, añade el siguiente bloque de código a tu código de desmantelamiento de pruebas (típicamente en un bloque afterEach):

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