Über axe DevTools Linter
Übersicht über axe DevTools Linter und diese Dokumentationsseite
Mit axe DevTools Linter können Sie Ihren Code auf Zugänglichkeitsprobleme überprüfen (ähnlich wie ein Code-Linter nach Codierungsproblemen sucht). Es ist einfach zu konfigurieren und zu verwenden. Es kann React (.js, .jsx und .tsx), Vue (.vue), Angular (.component.html, beachten Sie, dass die Überprüfung von Inline-Angular-Vorlagen derzeit nicht unterstützt wird), HTML (.html, .htm und .xhtml) und Markdown-Dateien (.md und .markdown) überprüfen, um häufige Zugänglichkeitsmängel zu vermeiden.
Editionen von Linter
Es gibt zwei Editionen von axe DevTools Linter:
- Die erste Edition, axe DevTools Linter Software as a Service (SaaS), ist ein Cloud-basierter Dienst, der von Deque bereitgestellt wird. Es wird in dieser Dokumentation als axe DevTools Linter SaaS bezeichnet, wenn es von der anderen Edition von axe DevTools Linter unterschieden werden muss.
- Der zweite, axe DevTools Linter On-Premises Server , ist ein Server, den Sie auf einem Linux-System installieren können, um Barrierefreiheits-Linterning-Dienste in Ihrer Organisation bereitzustellen. Es erfordert keine Authentifizierung und ist daher nur für die Verwendung hinter einer Firewall geeignet.
Lokales Linting
Das Befehlszeilentool axe DevTools Connector unterstützt lokales Linting, das Ihre Dateien lokal lintet, ohne den Dateiinhalt an einen Server zu senden. Weitere Informationen zur Verwendung des lokalen Lintings finden Sie im Abschnitt Lokales Linting des Artikels zum axe DevTools Linter Connector.
Dokumentationsübersicht
In diesem Abschnitt der Dokumentation finden Sie Folgendes:
Erhalten eines axe DevTools Linter SaaS-API-Schlüssels zeigt Ihnen, wie Sie einen Schlüssel erhalten, der Ihnen Zugriff auf Deques Cloud-basiertes axe DevTools Linter SaaS ermöglicht.
Wenn Sie die Software-as-a-Service-Version axe DevTools Linter SaaS verwenden, müssen Sie keinen Server einrichten und können sofort mit der Nutzung der axe DevTools Linter-Dienste beginnen. Sie benötigen lediglich einen API-Schlüssel, um die Dienste nutzen zu können.
Unter Herunterladen des axe DevTools Linter Connector finden Sie Informationen zum Bezug des axe DevTools Linter Connector. Dieser ist in der Dokumentation zum axe DevTools Linter Connector beschrieben.
Zugänglichkeitsregeln listet alle Regeln auf, die axe DevTools Linter prüft, wenn es Ihren Code auf Zugänglichkeitsprobleme überprüft. Zu jeder Regel gibt es einen Link mit weiteren Einzelheiten zur Deque University.
Konfigurieren von axe DevTools Linter bietet die Konfigurationsoptionen, die von der VS Code-Erweiterung, dem JetBrains-Plugin oder dem REST-API-Endpunkt /lint-source verstanden werden.
Die folgenden Abschnitte umfassen:
Installation und Sicherheit enthält Artikel, die Ihnen erklären, wie Sie den lokalen Server installieren und seinen Datenverkehr mit NGINX als Reverse-Proxy verschlüsseln.
Verwenden von axe DevTools Linter zeigt verschiedene Möglichkeiten, wie Sie mit axe DevTools Linter Code anhand der Zugänglichkeitsregeln von Deque überprüfen können, und wie Sie ihn in Jenkins, ein GitHub-Pre-Commit-Hook, eine GitHub-Aktion und [SonarQube] integrieren(axe-linter-with-sonarqube). Dieser Abschnitt enthält auch eine Erläuterung des JetBrains-Plugins und der VS Code-Erweiterung .
Linting von benutzerdefinierten Komponenten erläutert die Funktionen von axe DevTools Linter zum Linting von benutzerdefinierten Komponenten. In diesem Abschnitt gibt es zwei Anleitungen. Die erste ist für Benutzer der VS Code-Erweiterung oder des JetBrains-Plugins und die zweite ist für Benutzer des REST-Linting-Dienstes. Es gibt auch einen Artikel, der die Unterstützung für vorkonfigurierte Komponentenbibliotheken beschreibt.
Entwickeln mit den REST-APIs beschreibt, wie Sie programmgesteuert über die REST-Schnittstelle auf den Axe DevTools Linter zugreifen.
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.