À propos de Axe DevTools Linter
Aperçu de Axe DevTools Linter et de ce site de documentation
Qu'est-ce que le Linting ?
Le linting est le processus automatisé d'analyse du code source pour détecter les problèmes avant de l'exécuter. Un linter est un outil qui lit votre code et signale les problèmes, qu'il s'agisse d'erreurs de syntaxe, de fautes de frappe, d'incohérences stylistiques ou de bugs potentiels.
Le terme vient d'un outil Unix appelé lint, qui vérifiait à l'origine les programmes C pour détecter les constructions suspectes. Aujourd'hui, les linters existent pour pratiquement tous les langages de programmation et servent de première ligne de défense pour la qualité du code.
Pensez à un linter comme à un correcteur orthographique pour le code, sauf qu'au lieu de se limiter aux fautes de frappe, il détecte également les erreurs logiques, applique les règles de style et vous alerte sur les motifs susceptibles de provoquer des bugs.
Qu'est-ce qu'un Linter d'Accessibilité ?
Un linter d'accessibilité vérifie les mauvaises pratiques potentielles en matière d'accessibilité, vous fournissant des commentaires pendant que vous développez au lieu d'attendre que votre site Web ou application soit construit et fonctionnel.
Ce que fait Axe DevTools Linter
Axe DevTools Linter effectue une analyse statique de vos fichiers sources. Il lit votre code et le vérifie par rapport aux règles de Deque pour identifier les motifs susceptibles de causer des problèmes d'accessibilité. Par exemple, il peut détecter :
- Des images sans texte alternatif
- Des champs de formulaires sans étiquettes
- Des attributs ARIA incorrects ou manquants
- Des problèmes de structure des titres
Parce qu'il analyse le code source plutôt qu'une application en cours d'exécution, Axe DevTools Linter peut détecter ces problèmes tôt, avant que le code ne soit fusionné, déployé ou même compilé.
Ce que Axe DevTools Linter ne peut pas faire
Parce que Axe DevTools Linter est un outil d'analyse statique, il ne peut pas :
- Tester le comportement d'exécution de votre application, comme le contenu chargé dynamiquement ou les modifications de l'interface utilisateur pilotées par JavaScript.
- Identifier tous les problèmes d'accessibilité ; l'analyse statique couvre un sous-ensemble de défauts détectables, et certains problèmes nécessitent un test basé sur le navigateur ou une révision manuelle.
- Remplacer les tests d'accessibilité manuels ou les outils basés sur le navigateur.
Technologies prises en charge
Axe DevTools Linter peut vérifier les types de fichiers suivants :
| Technologie | Extensions de fichier |
|---|---|
| React | .js, .jsx, .tsx |
| Vue | .vue |
| Angular | .component.html |
| HTML | .html, .htm, .xhtml |
| LiquidJS | .liquid |
| HTL (Adobe Experience Manager) | .htl |
| Markdown | .md, .markdown |
| React Native | Voir Axe DevTools Linter pour React Native |
Moyens d'utiliser Axe DevTools Linter
Axe DevTools Linter peut être utilisé de plusieurs manières selon votre flux de travail :
Extensions IDE fournissent des commentaires en temps réel pendant que vous écrivez du code. L' extension VS Code (également disponible pour les IDE IA compatibles avec VS Code tels que Cursor et Windsurf) et le plugin JetBrains (WebStorm et IntelliJ IDEA Ultimate) indiquent les problèmes d'accessibilité directement dans votre éditeur au fur et à mesure que vous tapez.
Le Connecteur est un outil en ligne de commande pour l'analyse syntaxique des fichiers en lot, dans des scripts ou dans le cadre d'un pipeline CI/CD. Voir Utiliser Axe DevTools Linter Connector.
L'Action GitHub vérifie les fichiers qui ont été modifiés dans une demande de tirage et signale les problèmes d'accessibilité. Voir L'Action GitHub Axe DevTools Linter.
Autres intégrations CI/CD comprennent Jenkins, SonarQube, et les hooks Git pre-commit.
Où l'analyse est exécutée
Analyse locale: L'extension VS Code, le plugin JetBrains, et le Connecteur (avec l' --local option) effectuent tous l'analyse d'accessibilité sur votre propre machine. Le contenu des fichiers ne quitte jamais votre ordinateur.
Analyse sur serveur: Le Connecteur peut également envoyer vos fichiers à un serveur Axe DevTools Linter pour analyse. C'est l'approche utilisée par l'Action GitHub. Il existe deux options de serveur :
- SaaS hébergé par Deque: le serveur cloud de Deque. Nécessite une clé API; aucune configuration de serveur n'est nécessaire.
- Sur site: Un serveur que vous exécutez au sein de votre propre infrastructure. Voir Installation et Sécurité.
Pour obtenir des conseils sur le choix entre l'analyse locale et l'analyse sur serveur avec le Connecteur, voir Analyse Locale.
Aperçu de la Documentation
Obtenir une clé API SaaS Axe DevTools Linter vous montre comment obtenir une clé pour accéder au service d'analyse basé sur le cloud de Deque.
Règles d'Accessibilité répertorie toutes les règles que vérifie Axe DevTools Linter, avec des liens vers des informations détaillées sur Deque University.
Configuration de Axe DevTools Linter couvre les options de configuration disponibles dans l'extension VS Code, le plugin JetBrains, le Connecteur Axe DevTools Linter, et l'API REST /lint-source point de terminaison.
Installation et Sécurité contient des articles sur l'installation du serveur sur site et sa sécurisation avec NGINX en tant que proxy inverse.
Utilisation de Axe DevTools Linter couvre les diverses intégrations : le plugin JetBrains, extension VS Code, CLI du Connecteur, GitHub Action, hook pre-commit, Jenkins, et SonarQube.
Linting des composants personnalisés aborde la prise en charge par Axe DevTools Linter des composants personnalisés, avec des guides pour les utilisateurs de VS Code et JetBrains et utilisateurs de l'endpoint REST, plus un article sur les bibliothèques de composants préconfigurées.
Développement avec les APIs REST décrit comment accéder à Axe DevTools Linter de manière programmatique via son interface REST.
Crédits fournit des informations d'attribution et de licence pour les logiciels tiers utilisés par Axe DevTools Linter.
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.
