Instrucciones para Puppeteer 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 puppeteerConfig(), la función wrapPuppeteer() y la clase PuppeteerController de @axe-core/watcher/puppeteer:

import {
  puppeteerConfig,
  wrapPuppeteerPage,
  PuppeteerController
} from '@axe-core/watcher/puppeteer'

Actualiza tu código de configuración de pruebas (típicamente en un bloque before o beforeAll) envolviendo cualquier código existente para crear una instancia de browser con una llamada a puppeteerConfig(), mientras obtienes tu clave API del entorno (como ACCESSIBILITY_API_KEY):

// Original code:

browser = await puppeteer.launch({
  // Your existing launch options...
})

// Becomes:

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

const browser = await puppeteer.launch(
  puppeteerConfig({
    axe: {
      apiKey: ACCESSIBILITY_API_KEY,
      projectId: PROJECT_ID,
      serverURL: SERVER_URL
    },
    headless: false
  })
);

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

Crea una instancia de PuppeteerController y envuelve tu Puppeteer browserContext:

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

// Initialize the PuppeteerController by passing in the Puppeteer page.
const controller = new PuppeteerController(page)

// Use the new wrapped Puppeteer page instance.
page = wrapPuppeteerPage(page, controller)

Finalmente, asegúrese de que todos los resultados de las pruebas de Axe Watcher sean descartados. Para hacer esto, agregue el siguiente bloque de código a su código de desmantelamiento de pruebas (típicamente en un bloque afterEach):

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