Informazioni su axe DevTools Linter
Panoramica di axe DevTools Linter e di questo sito di documentazione
Axe DevTools Linter consente di effettuare il linting del codice per individuare problemi di accessibilità (in modo simile a come un linter di codice verifica la presenza di problemi di codifica). È facile da configurare e utilizzare. Può controllare i file React (.js, .jsx e .tsx), Vue (.vue), Angular (.component.html, nota che il controllo dei template Angular in linea non è attualmente supportato), HTML (.html, .htm e .xhtml) e Markdown (.md e .markdown), in modo da evitare comuni difetti di accessibilità.
Edizioni di Linter
Esistono due edizioni di axe DevTools Linter:
- Il primo, axe DevTools Linter Software as a Service (SaaS), è un servizio basato su cloud fornito da Deque. In questa documentazione, quando necessario per distinguerlo dalle altre edizioni di axe DevTools Linter, viene chiamato axe DevTools Linter SaaS .
- Il secondo, axe DevTools Linter On-Premises Server , è un server che puoi installare su una macchina Linux per fornire servizi di linting di accessibilità nella tua organizzazione. Non richiede autenticazione, quindi è adatto solo per l'uso dietro un firewall.
Linting locale
Lo strumento da riga di comando axe DevTools Connector supporta il linting locale, che esegue il linting dei file localmente senza inviare il contenuto del file a un server. Per ulteriori informazioni sull'utilizzo del linting locale, consultare la sezione Linting locale dell'articolo axe DevTools Linter Connector.
Panoramica della documentazione
In questa sezione della documentazione troverai quanto segue:
Come ottenere una chiave API per axe DevTools Linter SaaS mostra come ottenere una chiave che ti consenta di accedere al SaaS axe DevTools Linter basato su cloud di Deque.
Se utilizzi la versione software-as-a-service, axe DevTools Linter SaaS, non devi configurare un server e puoi iniziare a utilizzare immediatamente i servizi di axe DevTools Linter. Per iniziare a utilizzare i suoi servizi ti serve solo una chiave API.
Il download di axe DevTools Linter Connector fornisce informazioni su come ottenere axe DevTools Linter Connector, descritto nella documentazione per axe DevTools Linter Connector.
Regole di accessibilità elenca tutte le regole che axe DevTools Linter controlla durante il linting del codice per problemi di accessibilità. Ogni regola è collegata a maggiori dettagli su Deque University.
Configurazione di axe DevTools Linter fornisce le opzioni di configurazione riconosciute dall'estensione VS Code, dal plugin JetBrains o dall'endpoint /lint-source dell'API REST.
Le sezioni successive a questa includono:
Installazione e sicurezza contiene articoli che spiegano come installare il server locale e crittografarne il traffico utilizzando NGINX come proxy inverso.
Usare axe DevTools Linter mostra vari modi in cui è possibile utilizzare axe DevTools Linter per verificare il codice rispetto alle regole di accessibilità di Deque e come integrarlo con Jenkins, un hook di pre-commit di GitHub, un'azione di GitHub e SonarQube. In questa sezione è contenuta anche una discussione sul plugin JetBrains e sull'estensione VS Code .
Linting di componenti personalizzati illustra le funzionalità di axe DevTools Linter per il linting di componenti personalizzati. Questa sezione contiene due guide passo-passo. Il primo è per gli utenti dell'estensione VS Code o del plugin JetBrains, e il secondo è per gli utenti del servizio di linting REST. È disponibile anche un articolo che descrive il supporto per librerie di componenti preconfigurate.
Sviluppo con le API REST descrive come accedere ad axe DevTools Linter programmaticamente utilizzando la sua interfaccia 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.