Anleitungen für Cypress-Komponententests und TypeScript

Im Stammverzeichnis Ihres Testordners installieren Sie das Paket @axe-core/watcher und alle seine Abhängigkeiten mit npm oder Ihrem bevorzugten Paketmanager (zum Beispiel yarn oder pnpm).

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

Importieren Sie in cypress.config.ts die Funktion cypressConfig() aus dem Paket @axe-core/watcher und umgeben Sie Ihre Konfiguration damit. Setzen Sie das Array testingTypes so, dass es component enthält:

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',
      //},
    },
  })
);

Stellen Sie sicher, dass Sie ACCESSIBILITY_API_KEY und PROJECT_ID in Ihrer Umgebung auf Ihren persönlichen API-Schlüssel (zu finden in Ihrem Axe-Konto, **API-SCHLÜSSEL**-Tab) und Ihre Projekt-ID (angezeigt oben in diesen Anweisungen, als Sie Ihr Projekt erstellt haben, oder verfügbar auf der Seite "Projekte" durch Auswahl von **Projekt konfigurieren** unter **Einstellungen**) setzen. Wenn Ihre Organisation eine regionale, private Cloud oder eine lokale Axe Developer Hub-Instanz verwendet, setzen Sie auch SERVER_URL auf die Basis-URL dieser Instanz (zum Beispiel https://axe-eu.deque.com); andernfalls lassen Sie SERVER_URL weg und der Standard https://axe.deque.com wird verwendet.

Importieren Sie in Ihrer Cypress-Komponenten-Supportdatei (häufig cypress/support/component.ts genannt) @axe-core/watcher/cypress/support und rufen Sie axeWatcherFlush() nach jedem Test auf:

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

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

Das war's. Führen Sie Ihre Komponententests aus und überprüfen Sie Ihre Ergebnisse. Bitte beachten Sie, dass @axe-core/watcher nur in Chrome for Testing oder Chromium läuft und nur im Cypress-Run-Modus verwendet werden sollte. Es kann mit --headless=new oder --headed verwendet werden (zum Beispiel cypress run --headed --browser=chrome-for-testing --component).