Instruções para Teste de Componentes Cypress e JavaScript

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.js, importe a função cypressConfig() do pacote @axe-core/watcher e envolva sua configuração com ela. Configure o array testingTypes para incluir component:

const { defineConfig } = require('cypress');
const { cypressConfig } = require('@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

module.exports = 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 configurar ACCESSIBILITY_API_KEY e PROJECT_ID no seu ambiente com sua chave de API pessoal (encontrada na sua Conta Axe, aba **API KEYS**) e o ID do seu projeto (mostrado no topo destas instruções quando você criou seu projeto ou disponível na página de Projetos escolhendo **Configurar projeto** em **Configurações**). Se sua organização usar uma instância regional, nuvem privada ou local do Axe Developer Hub, também configure SERVER_URL com 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 de componentes do Cypress (comumente chamado cypress/support/component.js), importe o pacote @axe-core/watcher cypressCommands e chame axeWatcherFlush() após cada teste:

require('@axe-core/watcher/cypress/support');

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

Tudo pronto. Execute seus testes de componentes e verifique seus resultados. Por favor, note 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 utilizado com --headless=new ou --headed (por exemplo, cypress run --headed --browser=chrome-for-testing --component).