Migration vers axe DevTools for Web v4.x pour Node.js

Axe DevTools NPM v4.x est une réécriture majeure de l'ensemble du projet. Les changements les plus notables sont résumés ci-dessous, suivis de modifications plus spécifiques apportées aux packages concernés.

Résumé

La suite de packages npm axe-devtools-* a impliqué une perspective de rebranding et l'unification des outils d'intégration pour être plus spécifiques à l'expérience du développeur.

Dans cet esprit, tous les packages ont été renommés pour utiliser l'espace de noms axe devtools et les binaires ont été combinés en un seul package binaire.

Attention aux changements incompatibles

Compte tenu du changement de marque de l'API, il convient de souligner que la migration vers la version 4.0 implique de suivre ce guide de migration étape par étape.

Configuration de l'environnement

Il n'y a aucun changement par rapport aux exigences par défaut. Les exigences souhaitées sont les suivantes :

• [Node][] Version LTS
• [NPM][] pour les dépendances npm

Installation des packages axe DevTools NPM

Assurez-vous d'avoir accès au [registre de Deque][]. Dans le cas contraire, reportez-vous aux informations d’installation de votre package :

• Navigateur JS
• Cypress
• Playwright
• Marionnettiste
• WebdriverIO
• WebDriverJS

Vous pouvez installer l'un des packages npm ci-dessous en les incluant dans le fichier package.json.

npm install @axe-devtools/browser

// package.json
{
  "@axe-devtools/browser": "^4.0.0"
}

Les packages npm disponibles sont :

• [Axe DevTools CLI][]
• [axe DevTools Puppeteer][]
• [axe DevTools Reporter][]
• [Axe DevTools WebdriverIO][]
• [Axe DevTools WebDriverJS][]

Veuillez vous référer à chacun des packages npm ci-dessus, pour obtenir des instructions d'utilisation et une documentation API détaillée.

En option, vous pouvez désinstaller les intégrations Node.js précédentes (pour les packages avec ou sans portée) en exécutant les commandes ci-dessous :

npm uninstall attest-js
npm uninstall @deque/attest-js

Changements notables

Outre les modifications d'installation et d'utilisation des gemmes décrites, voici quelques changements notables :

• La variable d'environnement pour la configuration des règles personnalisées a été modifiée de ATTEST_PATH à AXE_RULESET_PATH.
• Les règles par défaut ont changé. axe DevTools audite une page donnée avec wcag2 comme ensemble de règles par défaut. Aucune modification n’est requise de la part de l’utilisateur final. Si l'on souhaite configurer un ensemble de règles différent, on peut utiliser @axe-devtools/cli pour générer un ensemble de règles différent ou créer un fichier axe-ruleset.json avec les ensembles de règles souhaités.
• Tous les packages utiliseront [axe-core v4.0.X][].
• axe DevTools WebdriverIO ne prendra plus en charge WebdriverIO v4 et ne prendra désormais en charge que WebdriverIO v5 et v6.

Modifications apportées aux binaires

Attest-standards et Attest Reporter ne seront plus livrés avec les binaires. Toutes les fonctionnalités précédentes des binaires seront incluses dans [@axe-devtools/cli][] sous forme de sous-commandes. Pour axe DevTools 4.0, Attest-standards sera obsolète et n'aura pas de version 4.0.

[@axe-devtools/cli] : cli-home [axe DevTools CLI] : cli-home [Axe DevTools Puppeteer] : node-pu-overview [Axe DevTools Reporter] : node-reporter [Axe DevTools WebdriverIO] : node-wi-overview [Axe DevTools WebDriverJS] : node-wj [registre de deque] : https://agora.dequecloud.com/artifactory/api/npm/devtools-npm [node] : https://nodejs.org/en/ [npm] : https://www.npmjs.com/ [axe-core v4.0.X] : https://www.npmjs.com/package/axe-core/v/4.0.1