1. 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
  2. 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 u ACCESSIBILITY_API_KEY en PROJECT_ID in uw omgeving instelt op uw persoonlijke API-sleutel (te vinden in uw axe-account, **API-SLEUTELS** tabblad) en uw project-ID (aangegeven bovenaan deze instructies toen u uw project maakte of beschikbaar op de projectenpagina door **Project configureren** te kiezen onder **Instellingen**). Als uw organisatie een regionale, private cloud of on-premises Axe Developer Hub-instance gebruikt, stel dan ook SERVER_URL in op de basis-URL van die instance (bijvoorbeeld https://axe-eu.deque.com); anders laat u SERVER_URL weg en wordt de standaard https://axe.deque.com gebruikt.

  3. 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();
    });
  4. 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).