Instruções para Puppeteer 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

No seu arquivo ou arquivos de teste, importe a função puppeteerConfig(), a função wrapPuppeteer() e a classe PuppeteerController de @axe-core/watcher/puppeteer:

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

Atualize seu código de configuração de testes (normalmente em um bloco before ou beforeAll) envolvendo qualquer código existente para criar uma instância de browser com uma chamada para puppeteerConfig(), enquanto obtém sua chave de API do ambiente (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
  })
);

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.

Crie uma instância de PuppeteerController e envolva seu browserContext do Puppeteer:

// 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)

Por fim, assegure-se de que todos os resultados de teste do axe Watcher sejam descarregados. Para fazer isso, adicione o seguinte bloco de código ao seu código de desmontagem de testes (normalmente em um bloco afterEach):

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