Instrucciones para WebdriverIO 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 tus archivos de prueba, importa la función wdioConfig(), la función wrapWdio() y la clase WdioController de @axe-core/watcher/wdio:

import {
  wdioConfig,
  wrapWdio,
  WdioController
} from '@axe-core/watcher/wdio'

En tu código de configuración de pruebas (típicamente en un bloque before o beforeAll), envuelve cualquier código existente para crear una instancia de browser con una llamada a wdioConfig(), proporcionando tu clave de 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 browser = await remote(
  wdioConfig({
    axe: {
      apiKey: ACCESSIBILITY_API_KEY,
      projectId: PROJECT_ID,
      serverURL: SERVER_URL
    }
  })
)

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.

Una vez que tengas una instancia de browser, crea una instancia de la clase WdioController:

const controller = new WdioController(browser);

Envuelve tu instancia browser con la función wrapWdio(), proporcionando la instancia browser y la instancia controller:

wrapWdio(browser, controller)

Por último, asegúrate de que todos los resultados de las pruebas de Axe Watcher sean eliminados. Para ello, añade el siguiente bloque de código a tu código de desintegración de pruebas (normalmente en un bloque afterEach):

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