Instrucciones para la Prueba de Componentes con Cypress 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 cypress.config.ts, importa la función cypressConfig() del paquete @axe-core/watcher y envuelve tu configuración con ella. Establece el array testingTypes para incluir component:

import { defineConfig } from 'cypress';
import { cypressConfig } from '@axe-core/watcher/cypress/config';

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

export default defineConfig(
  cypressConfig({
    axe: {
      apiKey: ACCESSIBILITY_API_KEY,
      projectId: PROJECT_ID,
      serverURL: SERVER_URL,
      testingTypes: ['component']
    },
    // Your existing Cypress configuration code here
    component: {
      // Your component testing configuration
      
      // For example:
      
      // devServer: {
      //  framework: 'react',
      //  bundler: 'webpack',
      //},
    },
  })
);

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.

En tu archivo de soporte de componentes de Cypress (comúnmente llamado cypress/support/component.ts), importa @axe-core/watcher/cypress/support y llama a axeWatcherFlush() después de cada prueba:

import '@axe-core/watcher/cypress/support';

afterEach(() => {
  cy.axeWatcherFlush();
});

Has terminado. Ejecuta tus pruebas de componentes y revisa tus resultados. Por favor, ten en cuenta que @axe-core/watcher solo se ejecuta en Chrome para Testing o Chromium y solo debe usarse en modo de ejecución de Cypress. Se puede usar con --headless=new o --headed (por ejemplo, cypress run --headed --browser=chrome-for-testing --component).