Over Axe DevTools Linter
Overzicht van Axe DevTools Linter en deze documentatiesite
Wat is linten?
Linten is het geautomatiseerde proces van het analyseren van broncode om problemen te vinden voordat je de code uitvoert. Een linter is een tool die je code leest en issues markeert, variërend van syntaxisfouten en typfouten tot stilistische inconsistenties en potentiële bugs.
De term komt van een Unix-tool genaamd lint, die oorspronkelijk C-programma's controleerde op verdachte constructies. Tegenwoordig bestaan er linters voor vrijwel elke programmeertaal en dienen ze als eerste verdedigingslinie in codekwaliteit.
Denk aan een linter als een spellingscontrole voor code; behalve dat het niet alleen typfouten vindt, maar ook logische fouten, stijlregels handhaaft en je waarschuwt voor patronen die waarschijnlijk fouten veroorzaken.
Wat is een toegankelijkheidslinter?
Een toegankelijkheidslinter controleert op mogelijk slechte toegankelijkheidspraktijken en geeft je feedback terwijl je ontwikkelt in plaats van nadat je website of applicatie is gebouwd en draait.
Wat Axe DevTools Linter doet
Axe DevTools Linter voert statische analyse uit van je bronbestanden. Het leest je code en controleert deze tegen Deques regels om patronen te identificeren die waarschijnlijk toegankelijkheidsproblemen veroorzaken. Bijvoorbeeld, het kan detecteren:
- Afbeeldingen zonder alternatieve tekst
- Formuliervelden zonder labels
- Onjuiste of ontbrekende ARIA-attributen
- Problemen met de kopstructuur
Omdat het broncode analyseert in plaats van een draaiende applicatie, kan Axe DevTools Linter deze problemen vroeg opsporen, voordat code wordt samengevoegd, geïmplementeerd of zelfs gecompileerd.
Wat Axe DevTools Linter niet kan doen
Omdat Axe DevTools Linter een statische analysetool is, kan het niet:
- Het runtime-gedrag van je applicatie testen, zoals dynamisch geladen content of door JavaScript aangedreven UI-wijzigingen.
- Elke toegankelijkheidsprobleem vinden; statische analyse dekt een subset van detecteerbare defecten, en sommige issues vereisen browsergebaseerde tests of handmatige beoordeling.
- Handmatige toegankelijkheidstests of browsergebaseerde tools vervangen.
Ondersteunde technologieën
Axe DevTools Linter kan de volgende bestandstypen controleren:
| Technologie | Bestandsextensies |
|---|---|
| React | .js, .jsx, .tsx |
| Vue | .vue |
| Angular | .component.html |
| HTML | .html, .htm, .xhtml |
| LiquidJS | .liquid |
| Markdown | .md, .markdown |
| React Native | Zie Axe DevTools Linter voor React Native |
Manieren om Axe DevTools Linter te gebruiken
Axe DevTools Linter kan op verschillende manieren worden gebruikt, afhankelijk van je workflow:
IDE-extensies bieden realtime feedback terwijl je code schrijft. De VS Code-extensie en JetBrains-plug-in (WebStorm en IntelliJ IDEA Ultimate) geven toegankelijkheidsproblemen direct in je editor aan terwijl je typt.
De Connector is een commandoregeltool voor het linten van bestanden in batch, in scripts of als onderdeel van een CI/CD-pipeline. Zie Using Axe DevTools Linter Connector.
De GitHub-actie controleert bestanden die zijn gewijzigd in een pull-aanvraag en rapporteert toegankelijkheidsproblemen. Zie The Axe DevTools Linter GitHub Action.
Andere CI/CD-integraties omvatten Jenkins, SonarQube, en Git pre-commit hooks.
Waar analyse plaatsvindt
Lokale linting: De VS Code-extensie, JetBrains-plugin en de Connector (met de --local optie) voeren allemaal toegankelijkheidsanalyses uit op je eigen machine. Bestandsinhoud verlaat je computer nooit.
Servergebaseerde linting: De Connector kan je bestanden ook naar een Axe DevTools Linter-server sturen voor analyse. Dit is de methode die door de GitHub-actie wordt gebruikt. Er zijn twee serveropties:
- Deque gehoste SaaS: Deques cloudserver. Vereist een API-sleutel; geen serverinstellingen nodig.
- Op locatie: Een server die je binnen je eigen infrastructuur beheert. Zie Installatie en beveiliging.
Voor richtlijnen over de keuze tussen lokaal en servergebaseerd linten met de Connector, zie Lokale linting.
Documentatieoverzicht
Verkrijgen van een Axe DevTools Linter SaaS API-sleutel laat zien hoe je een sleutel krijgt om toegang te krijgen tot de cloudgebaseerde lintdienst van Deque.
Toegankelijkheidsregels somt alle regels op die Axe DevTools Linter controleert, met links naar gedetailleerde informatie op Deque University.
Configureren van Axe DevTools Linter behandelt de configuratie-opties die beschikbaar zijn in de VS Code-extensie, de JetBrains-plugin, de Axe DevTools Linter Connector, en de REST API /lint-source eindpunt.
Installatie en beveiliging bevat artikelen over het installeren van de on-premises server en het beveiligen hiervan met NGINX als een reverse proxy.
Gebruik van Axe DevTools Linter behandelt de verschillende integraties: de JetBrains-plugin, VS Code-extensie, Connector CLI, GitHub-actie, pre-commit hook, Jenkins, en SonarQube.
Linting van Aangepaste Componenten bespreekt de ondersteuning van Axe DevTools Linter voor aangepaste componenten, met handleidingen voor VS Code- en JetBrains-gebruikers en REST-eindpuntgebruikers, plus een artikel over vooraf geconfigureerde componentbibliotheken.
Ontwikkelen met de REST-API's beschrijft hoe je Axe DevTools Linter programmatisch kunt benaderen via de REST-interface.
Credits biedt naamsvermelding en licentie-informatie voor software van derden die door Axe DevTools Linter wordt gebruikt.
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.