À propos d'axe DevTools Linter
Présentation d'axe DevTools Linter et de ce site de documentation
axe DevTools Linter vous permet de vérifier votre code pour détecter les problèmes d'accessibilité (de la même manière qu'un linter de code vérifie les problèmes de codage). Il est facile à configurer et à utiliser. Il peut vérifier les fichiers React (.js, .jsx et .tsx), Vue (.vue), Angular (.component.html, notez que la vérification des modèles Angular en ligne n'est actuellement pas prise en charge), HTML (.html, .htm et .xhtml) et Markdown (.md et .markdown) afin que vous puissiez éviter les défauts d'accessibilité courants.
Éditions de Linter
Il existe deux éditions d'axe DevTools Linter :
- Le premier, axe DevTools Linter Software as a Service (SaaS), est un service basé sur le cloud fourni par Deque. Il est appelé axe DevTools Linter SaaS dans cette documentation lorsqu'il est nécessaire de le distinguer de l'autre édition d'axe DevTools Linter.
- Le deuxième, axe DevTools Linter On-Premises Server est un serveur que vous pouvez installer sur une machine Linux pour fournir des services d'analyse d'accessibilité dans votre organisation. Il ne nécessite aucune authentification, il ne convient donc qu'à une utilisation derrière un pare-feu.
Linting local
L'outil de ligne de commande axe DevTools Connector prend en charge le linting local, qui analyse vos fichiers localement sans envoyer le contenu du fichier à un serveur. Vous pouvez trouver plus d'informations sur l'utilisation du linting local dans la section Local Linting de l'article axe DevTools Linter Connector.
Présentation de la documentation
Dans cette section de la documentation, vous trouverez les éléments suivants :
Obtention d'une clé API axe DevTools Linter SaaS vous montre comment obtenir une clé pour vous permettre d'accéder à l'axe DevTools Linter SaaS basé sur le cloud de Deque.
Si vous utilisez la version logiciel en tant que service, axe DevTools Linter SaaS, vous n'avez pas besoin de configurer un serveur et pouvez commencer à utiliser les services axe DevTools Linter immédiatement. Vous n'avez besoin que d'une clé API pour commencer à utiliser ses services.
Le téléchargement de l'axe DevTools Linter Connector vous donne des informations sur la façon d'obtenir l'axe DevTools Linter Connector, qui est décrit dans la documentation de l'axe DevTools Linter Connector.
Règles d'accessibilité répertorie toutes les règles qu'axe DevTools Linter vérifie lorsqu'il analyse votre code pour détecter les problèmes d'accessibilité. Chaque règle est liée à plus de détails sur Deque University.
Configuring axe DevTools Linter fournit les options de configuration comprises par l'extension VS Code, le plugin JetBrains ou le point de terminaison REST API /lint-source.
Les sections qui suivent celle-ci incluent :
[Installation et sécurité] (setup-linter-home) contient des articles qui vous expliquent comment installer le serveur sur site et chiffrer son trafic à l'aide de NGINX comme proxy inverse.
Utilisation d'axe DevTools Linter montre différentes manières d'utiliser axe DevTools Linter pour vérifier le code par rapport aux règles d'accessibilité de Deque et comment l'intégrer avec Jenkins, un hook de pré-validation GitHub, une action GitHub et SonarQube. Une discussion sur le plugin JetBrains et l'extension VS Code est également contenue dans cette section.
Linting Custom Components aborde les fonctionnalités d'axe DevTools Linter pour l'analyse des composants personnalisés. Il y a deux procédures pas à pas dans cette section. Le premier est destiné aux utilisateurs de l'extension VS Code ou du plugin JetBrains, et le second aux utilisateurs du service de linting REST. Il existe également un article décrivant la prise en charge des bibliothèques de composants préconfigurés.
Développement avec les API REST décrit comment accéder à axe DevTools Linter par programmation à l'aide de son interface REST.
Note: It is never necessary to use Deque's software or services in a way that collects, stores, or shares personal data. Do not use the software or services in a manner that collects, stores, or shares personal data.