Instruções para Testes de Componentes Cypress e TypeScript

No nível raiz da sua pasta de testes, instale o pacote @axe-core/watcher e todas as suas dependências usando o npm ou seu gerenciador de pacotes preferido (por exemplo, yarn ou pnpm).

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

Em cypress.config.ts, importe a função cypressConfig() do pacote @axe-core/watcher e envolva sua configuração com ela. Defina o 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',
      //},
    },
  })
);

Certifique-se de definir ACCESSIBILITY_API_KEY e PROJECT_ID no seu ambiente para a sua chave API pessoal (encontrada na sua conta axe, aba **API KEYS**) e para o ID do seu projeto (mostrado na parte superior destas instruções quando você criou o seu projeto ou disponível na página Projetos ao escolher **Configurar projeto** em **Configurações**). Se a sua organização usa uma instância regional, em nuvem privada ou local do Axe Developer Hub, também defina SERVER_URL para a URL base dessa instância (por exemplo, https://axe-eu.deque.com); caso contrário, omita SERVER_URL e o padrão https://axe.deque.com será utilizado.

No seu arquivo de suporte do componente Cypress (comumente chamado cypress/support/component.ts), importe @axe-core/watcher/cypress/support e chame axeWatcherFlush() após cada teste:

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

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

Pronto. Execute seus testes de componentes e verifique seus resultados. Observe que @axe-core/watcher só roda no Chrome para testes ou no Chromium e deve ser usado apenas no modo de execução do Cypress. Ele pode ser usado com --headless=new ou --headed (por exemplo, cypress run --headed --browser=chrome-for-testing --component).