Instructies voor Cypress en TypeScript

Installeer in de hoofdmap van je testmap het @axe-core/watcher-pakket en al zijn afhankelijkheden met npm of je voorkeurspakketbeheerder (bijvoorbeeld yarn of pnpm).

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

Importeer in cypress.config.ts de cypressConfig()-functie uit het @axe-core/watcher-pakket en omring uw configuratie ermee:

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
    },
    // Your existing Cypress configuration code here
  })
);

Zorg ervoor dat je ACCESSIBILITY_API_KEY en PROJECT_ID in je omgeving instelt op je persoonlijke API-sleutel (te vinden in je Axe-account, tabblad **API-SLEUTELS**) en je project-ID (weergegeven bovenaan deze instructies toen je je project maakte of beschikbaar van de Projecten-pagina door **Project configureren** te kiezen onder **Instellingen**). Als je organisatie een regionale, private cloud of on-premises Axe Developer Hub-instantie gebruikt, stel dan ook SERVER_URL in op de basis-URL van die instantie (bijvoorbeeld, https://axe-eu.deque.com); zo niet, laat dan SERVER_URL weg en zal de standaard https://axe.deque.com gebruikt worden.

Importeer in uw Cypress-supportbestand (doorgaans genaamd cypress/support/e2e.ts) @axe-core-watcher/cypress/support en roep axeWatcherFlush() aan na elke test:

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

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

Je bent klaar. Voer je end-to-end tests uit en controleer je resultaten. Let op, @axe-core/watcher draait alleen in Chrome voor Testing of Chromium en zou alleen in Cypress uitvoeren modus gebruikt moeten worden. Het kan gebruikt worden met --headless=new of --headed (bijvoorbeeld, cypress run --headed --browser=chrome-for-testing).