Informazioni su Axe DevTools Linter
Panoramica di Axe DevTools Linter e di questo sito di documentazione
Che cos'è il Linting?
Il linting è il processo automatizzato di analisi del codice sorgente per trovare problemi prima di eseguirlo. Un linter è un strumento che legge il tuo codice e segnala problemi, da errori di sintassi e refusi a incoerenze stilistiche e potenziali bug.
Il termine deriva da uno strumento Unix chiamato lint, che originariamente controllava i programmi C alla ricerca di costrutti sospetti. Oggi, i linters esistono praticamente per ogni linguaggio di programmazione e fungono da prima linea di difesa nella qualità del codice.
Pensa a un linter come a un correttore ortografico per il codice, tranne per il fatto che, invece di rilevare solo i refusi, individua anche errori logici, applica le regole di stile e ti avverte su modelli che potrebbero causare bug.
Che cos'è un Accessibility Linter?
Un accessibility linter controlla le pratiche potenzialmente dannose per l'accessibilità, fornendo feedback durante lo sviluppo piuttosto che dopo che il tuo sito web o applicazione è costruito e funzionante.
Cosa fa Axe DevTools Linter
Axe DevTools Linter esegue un'analisi statica dei tuoi file sorgente. Legge il tuo codice e lo verifica rispetto alle regole di Deque per identificare modelli che potrebbero causare problemi di accessibilità. Ad esempio, può rilevare:
- Immagini senza testo alternativo
- Campi di input del modulo senza etichette
- Attributi ARIA errati o mancanti
- Problemi nella struttura dei titoli
Poiché analizza il codice sorgente anziché un'applicazione in esecuzione, Axe DevTools Linter può intercettare questi problemi in anticipo, prima che il codice venga unito, distribuito o addirittura compilato.
Cosa non può fare Axe DevTools Linter
Poiché Axe DevTools Linter è uno strumento di analisi statica, non può:
- Testare il comportamento di runtime della tua applicazione, come contenuti caricati dinamicamente o modifiche dell'interfaccia utente guidate da JavaScript.
- Rilevare ogni problema di accessibilità; l'analisi statica copre solo un sottoinsieme di difetti rilevabili e alcuni problemi richiedono test nel browser o revisioni manuali.
- Sostituire test manuali di accessibilità o strumenti basati sul browser.
Tecnologie supportate
Axe DevTools Linter può controllare i seguenti tipi di file:
| Tecnologia | Estensioni file |
|---|---|
| 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 | Vedi Axe DevTools Linter per React Native |
Modi per usare Axe DevTools Linter
Axe DevTools Linter può essere utilizzato in vari modi a seconda del tuo flusso di lavoro:
Estensioni IDE forniscono feedback in tempo reale mentre scrivi il codice. L'estensione VS Code (disponibile anche per IDE AI compatibili con VS Code come Cursor e Windsurf) e il plugin di JetBrains (WebStorm e IntelliJ IDEA Ultimate) indicano i problemi di accessibilità direttamente nel tuo editor mentre digiti.
Il Connettore è uno strumento da linea di comando per la linting di file in batch, negli script o come parte di una pipeline CI/CD. Vedi Utilizzo del Connettore Axe DevTools Linter.
L'Azione GitHub controlla i file che sono stati modificati in una pull request e segnala problemi di accessibilità. Vedi L'Azione GitHub di Axe DevTools Linter.
Altre integrazioni CI/CD includono Jenkins, SonarQube, e hook pre-commit Git.
Dove Avviene l'Analisi
Linting locale: L'estensione per VS Code, il plugin JetBrains e il Connettore (con l'opzione --local ) eseguono tutti l'analisi dell'accessibilità direttamente sul tuo computer. I contenuti dei file non lasciano mai il tuo dispositivo.
Linting basato su server: Il Connettore può anche inviare i tuoi file a un server Axe DevTools Linter per l'analisi. Questo è l'approccio utilizzato dall'Azione GitHub. Ci sono due opzioni di server:
- SaaS ospitato da Deque: il cloud server di Deque. Richiede una chiave API; non è necessaria la configurazione del server.
- On-premises: un server che gestisci all'interno della tua infrastruttura. Vedi Installazione e Sicurezza.
Per indicazioni su come scegliere tra il linting locale e quello basato su server con il Connettore, vedi Linting Locale.
Panoramica della Documentazione
Ottenere una Chiave API di Axe DevTools Linter SaaS ti mostra come ottenere una chiave per accedere al servizio di linting basato su cloud di Deque.
Regole di Accessibilità elenca tutte le regole che Axe DevTools Linter verifica, con link a informazioni dettagliate su Deque University.
Configurazione di Axe DevTools Linter copre le opzioni di configurazione disponibili nell'estensione per VS Code, il plugin JetBrains, il Connettore di Axe DevTools Linter e l'API REST /lint-source endpoint.
Installazione e Sicurezza contiene articoli sull'installazione del server on-premises e sulla sua protezione con NGINX come proxy inverso.
Utilizzo di Axe DevTools Linter copre le varie integrazioni: il plugin JetBrains, estensione VS Code, Connettore CLI, GitHub Action, hook pre-commit, Jenkins, e SonarQube.
Linting dei Componenti Personalizzati discute del supporto di Axe DevTools Linter per i componenti personalizzati, con tutorial per utenti di VS Code e JetBrains e utenti di endpoint REST, oltre a un articolo su librerie di componenti preconfigurati.
Sviluppo con le API REST descrive come accedere programmaticamente a Axe DevTools Linter utilizzando la sua interfaccia REST.
Crediti fornisce informazioni sui crediti e sulle licenze per il software di terze parti utilizzato da 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.