Instructions pour le test de composants avec Cypress et TypeScript

Au niveau racine de votre dossier de test, installez le package @axe-core/watcher et toutes ses dépendances en utilisant npm ou votre gestionnaire de packages préféré (par exemple, yarn ou pnpm).

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

Dans cypress.config.ts, importez la fonction cypressConfig() du package @axe-core/watcher et encapsulez votre configuration avec celle-ci. Définissez le tableau testingTypes pour inclure component :

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

Assurez-vous de définir ACCESSIBILITY_API_KEY et PROJECT_ID dans votre environnement avec votre clé API personnelle (trouvée dans votre compte axe, onglet **CLÉS API**) et votre ID de projet (indiqué en haut de ces instructions lorsque vous avez créé votre projet ou disponible sur la page Projets en choisissant **Configurer le projet** sous **Paramètres**). Si votre organisation utilise une instance Axe Developer Hub régionale, privée, ou sur site, définissez également SERVER_URL sur l’URL de base de cette instance (par exemple, https://axe-eu.deque.com); sinon, omettez SERVER_URL et la valeur par défaut https://axe.deque.com sera utilisée.

Dans votre fichier de support de composants Cypress (généralement appelé cypress/support/component.ts), importez @axe-core/watcher/cypress/support et appelez axeWatcherFlush() après chaque test :

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

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

Vous avez terminé. Exécutez vos tests de composants et vérifiez vos résultats. Veuillez noter que @axe-core/watcher fonctionne uniquement dans Chrome pour Testing ou Chromium et doit être utilisé uniquement en mode exécution Cypress. Il peut être utilisé avec --headless=new ou --headed (par exemple, cypress run --headed --browser=chrome-for-testing --component).