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

This page is not available in the language you requested. You have been redirected to the English version of the page.

Link to this page copied to clipboard

Étapes pour migrer vers la version 4.x d'Axe DevTools pour le Web pour Node.js

Not for use with personal data

Axe DevTools NPM v4.x est une réécriture majeure de l'intégralité du projet. Les changements les plus notables sont résumés ci-dessous, suivis par des changements plus spécifiques aux paquets concernés.

Résumé

La suite de axe-devtools-* packages npm implique une perspective de rebranding ainsi qu'une unification des outils d'intégration pour être plus adaptés à l'expérience des développeurs.

Dans cet esprit, tous les packages ont été rebrandés pour utiliser le namespace axe devtools et les binaires ont été combinés en un seul package binaire.

Attention aux changements rétro-incompatibles

Étant donné le rebranding de l'API, il est juste de préciser que la migration vers la v4.0 nécessite de suivre ce guide de migration étape par étape.

Configuration de l'environnement

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

Version LTS de Node
NPM pour les dépendances npm

Installation des packages NPM Axe DevTools

Assurez-vous d'avoir accès à Deque's registry. Si ce n'est pas le cas, consultez les informations d'installation pour votre package :

Vous pouvez installer n'importe lequel 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 :

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

Le cas échéant, vous pouvez désinstaller les intégrations Node 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

En plus des changements d'installation et d'utilisation des modules mentionnés, certains changements notables incluent :

La variable d'environnement pour configurer les règles personnalisées a été changée de ATTEST_PATH à AXE_RULESET_PATH.
Le jeu de règles par défaut a changé. Axe DevTools audite une page donnée avec wcag2 comme ensemble de règles par défaut. Aucun changement n'est requis par l'utilisateur final. Si on souhaite configurer un autre jeu de règles, 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 jeux 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.

Changements aux binaires

Attest-standards et Attest Reporter ne seront plus livrés avec des binaires. Toutes les fonctionnalités précédentes des binaires seront incluses dans @axe-devtools/cli en tant que sous-commandes. Pour Axe DevTools 4.0, Attest-standards sera supprimé et ne disposera pas d'une version 4.0.