Axe DevTools per Web CLI
Uno strumento a riga di comando per automatizzare i test di accessibilità web senza scrivere codice di test.
Axe DevTools per Web CLI è uno strumento a riga di comando che esegue analisi di accessibilità sulle pagine web e genera rapporti. È progettato per i team che vogliono automatizzare i test di accessibilità senza integrare axe in un framework di test esistente, ad esempio, come fase di una pipeline CI/CD, o quando le API di Axe DevTools non sono disponibili per la tua lingua.
Come funziona
Ogni axe analisi produce file di risultati JSON, uno per ogni stato della pagina analizzato. Questi file vengono prodotti durante i test e vengono utilizzati quando si riportano o caricano i risultati.
Il flusso di lavoro tipico ha due fasi:
-
Analizzare le pagine: eseguire uno o più URL tramite
axee salvare i risultati JSON:axe <url> → test a URL directly axe spec <spec-file> → test pages and workflows defined in a YAML/JSON file axe bulk-spec <dir> → test using all spec files in a directory -
Fare qualcosa con i risultati: convertirli, caricarli o inviarli altrove:
axe reporter <results> → generate HTML, JUnit XML, or CSV reports axe bulk-reports <results> → upload to the Axe Reports service axe devhub <results> → send to Axe Developer Hub
I comandi axe e axe spec supportano anche le --format opzioni per generare rapporti in un solo passaggio, senza un' --report invocazione separata. axe reporter .
Comandi
| Comando | Scopo |
|---|---|
axe <url...> |
Analizzare direttamente uno o più URL. Browser predefinito: Firefox. Set di regole predefinito: WCAG 2.1 AA. |
axe spec <spec-file> |
Analizzare le pagine definite in un file di specifiche YAML o JSON, inclusi flussi di lavoro a più passaggi. |
axe bulk-spec <dir> |
Esegui tutti i file di specifiche trovati in una directory e nelle sue sottodirectory. |
axe reporter <results-dir> |
Convertire i risultati JSON in rapporti HTML, JUnit XML o CSV. |
axe bulk-reports <results-dir> |
Caricare i risultati JSON al servizio Axe Reports. |
axe devhub <results-dir> |
Inviare i risultati JSON a Axe Developer Hub. |
axe ruleset |
Elencare, validare o gestire set di regole personalizzati. |
axe config-selenium |
Visualizzare o aggiornare le impostazioni predefinite del browser/Selenium. |
Risultati JSON
Quando esegui axe spec o utilizzi axe <url> --save, i risultati vengono scritti come file JSON nella directory di output. Ogni file cattura l'intera axe analisi per un singolo stato della pagina: violazioni, passaggi, controlli incompleti e regole inapplicabili, insieme a metadati come l'URL, il browser e il timestamp.
I file dei risultati sono organizzati per progetto e nominati in base alla pagina testata:
<output-dir>/<project-id>/<project-id>-<page-id>[-<analyze-title>].jsonQuesti file vengono utilizzati da axe reporter, axe bulk-reports, e axe devhub. Per i dettagli sulla denominazione dei file e la struttura delle directory, vedere Generare Rapporti.
Lo schema dei risultati JSON è definito da axe-core. Per un riferimento completo, vedere la documentazione API di axe-core.
In Questa Sezione
- Inizia: attività comuni con esempi pratici
- Installa: opzioni di installazione (eseguibile o pacchetto Node.js)
- Analizza Pagine: tutte le opzioni per
axe <url> - Analizzare Pagine Usando un File Spec: struttura del file spec, azioni e elaborazione batch
- Genera Report: formati del report, filtraggio e struttura dei risultati JSON
- Invia a Axe Reports: carica i risultati sul servizio Axe Reports
- Invia a Axe Developer Hub: integra i risultati con Axe Developer Hub
- Configura: selezione del browser, timeout e impostazioni persistenti
- Set di Regole Personalizzato: WCAG 2.x, Sezione 508 e set di regole personalizzato