Présentation du package @axe-core/watcher
Le package @axe-core/watcher est intégré à votre suite de tests pour tester les erreurs d'accessibilité
Vue d'ensemble de la documentation pour Watcher
Les informations contenues dans la section @axe-core/watcher de la documentation sont les suivantes :
- Cet article, Vue d'ensemble, décrit le package @axe-core/watcher (également appelé Watcher ou axe Watcher). Vous trouverez ici des informations générales sur le package, où vous pouvez le télécharger, comment l'installer et des liens vers d'autres ressources.
- Configuration système requise couvre les versions et les spécificités des logiciels à utiliser avec Watcher.
- Les articles sous Instructions JavaScript et Instructions TypeScript fournissent des instructions pour l'intégration de Watcher avec plusieurs frameworks de test différents et incluent des exemples d'extraits pour JavaScript et TypeScript. Il s’agit des mêmes informations que celles que vous voyez lorsque vous créez un projet sur le site axe Developer Hub.
- Référence API fournit un guide des API fournies par le package @axe-core/watcher.
Qu'est-ce que Watcher ?
Le package @axe-core/watcher vous permet d'ajouter facilement des tests d'accessibilité à votre suite de tests existante. Il s'agit d'un package Node.js disponible sur npmjs.com et fonctionne actuellement avec les frameworks de test les plus populaires. Vos tests peuvent être écrits en JavaScript ou TypeScript.
Le package @axe-core/watcher, une fois intégré à votre suite de tests de bout en bout :
- Ajoute une validation d'accessibilité à votre suite de tests existante avec des modifications de code minimales, grâce à Watcher enveloppant les méthodes et appels de fonctions importants de votre framework de test.(dh-glossary#wrapping)
- Analyse automatiquement les pages Web lorsque vous exécutez votre suite de tests et réanalyse les pages lors de la détection de toute modification du DOM (chaque modification est considérée comme un [état de page] distinct(dh-glossary#page-state)) - parfait pour les applications Web à page unique et autres sites complexes avec des pages de connexion et d'autres contenus dynamiques.
- Associe les commits Git aux résultats d'accessibilité pour vous permettre d'évaluer l'accessibilité de chaque commit et de surveiller la progression globale de l'accessibilité de votre projet.
- Envoie les résultats d'accessibilité liés à chaque état de page et à la validation Git vers axe Developer Hub, où les résultats sont suivis, dédupliqués et présentés.
Comment obtenir
La dernière version de @axe-core/watcher est disponible sur npmjs.com.
Installation
Vous pouvez installer le package dans votre projet Node.js en tant que dépendance de développement avec la commande suivante :
npm install --save-dev @axe-core/watcherExigences du système
Pour connaître les configurations système requises pour @axe-core/watcher, consultez Configuration système requise.
Même si le site Web axe Developer Hub offre une large prise en charge des navigateurs, seul Google Chrome est pris en charge par le package @axe-core/watcher pour les tests. Ainsi, par exemple, vous ne pouvez pas utiliser le navigateur Electron par défaut de Cypress pour exécuter vos tests.
Référence API
Pour une référence aux API fournies par le package @axe-core/watcher, voir Référence API.
Notes de version
Pour plus d'informations sur les modifications apportées à @axe-core/watcher, consultez les Notes de publication de @axe-core/watcher.
Le référentiel d'exemples
Vous pouvez expérimenter avec le code dans le référentiel d'exemples sur GitHub. Il contient des exemples pour :
Instructions pour modifier votre suite de tests
La section instructions de la documentation inclut des instructions pour modifier votre suite de tests afin d'inclure le package @axe-core/watcher.
Ce sont les mêmes instructions que vous voyez lorsque vous créez un nouveau projet dans axe Developer Hub.
Les sections suivantes contiennent des liens vers les instructions de chaque framework de test :