Generare report

Quando utilizzi le API di Axe DevTools o la axe CLI per testare l'accessibilità, i risultati vengono salvati come file JSON. Usa il axe reporter comando per convertire questi file JSON in report HTML, JUnit XML o CSV. Puoi anche filtrare i risultati per tipo prima di generare un report.

• Il segmento axe reporter Comando
• Opzioni
• Risultati JSON sul disco

Il segmento axe reporter Comando

axe reporter <results-dir> [dest-dir] [options]

Il segmento <results-dir> è la directory contenente i file di risultati JSON. L'opzionale [dest-dir] è dove vengono scritti i report; puoi anche utilizzare --dest per specificarlo.

Genera un report CSV dai risultati JSON:

axe reporter ./axe-results/ ./axe-reports/csv/ --format=csv

Genera report in più formati contemporaneamente:

axe reporter ./axe-results/ ./axe-reports/ --format=csv,html,junit

Opzioni

-d, --dest <path>

Specifica la directory di output per i report generati. Puoi anche specificare la destinazione come secondo argomento posizionale.

-f, --format <type(s)>

Formato/i di output: html, junit (XML), o csv. Per generare più formati in un'unica esecuzione, forniscili separati da virgole, spazi, punti e virgola o segni più. Gli spazi intorno ai separatori sono ignorati.

--filter <type(s)>

Filtra quali tipi di risultati includere nel report. Accetta uno o più dei seguenti: passes, violations, incomplete, inapplicable. Separa più valori con virgole senza spazi. Richiede --format csv.

# Include only violations and incomplete results
axe reporter ./axe-results/ --format=csv --filter violations,incomplete

# Include only passed checks
axe reporter ./axe-results/ --format=csv --filter passes

-b, --browser <name>

Quando una directory di risultati contiene risultati da più browser, utilizza questa opzione per generare un report solo dai risultati di un browser. Il nome dovrebbe corrispondere al browser utilizzato durante l'esecuzione dei test, per esempio, chrome o firefox.

Risultati JSON sul disco

Comprendere come la CLI di Axe DevTools nomina e organizza i file di risultati JSON è utile quando lavori con il axe reporter comando o elabori i risultati in modo programmato.

Struttura della Directory

Per ogni progetto in un file di specifica, i risultati sono salvati in una sottodirectory che prende il nome dal iddel progetto, all'interno della directory di output specificata:

<output-dir>/<project-id>/

Questa sottodirectory viene creata automaticamente. Se esiste già da un'esecuzione precedente, viene archiviata rinominandola in <project-id>-<timestamp> prima di crearne una nuova.

Denominazione dei File

Ogni file di risultato JSON è nominato usando il progetto id e uno stato della pagina derivato dalla pagina id e l'opzionale title dall'azione analyze :

<project-id>-<page-id>[-<analyze-title>].json

La pagina id proviene dal campo id in pageList. Se id non è espressamente impostato su una pagina, viene derivato automaticamente dalla pagina name rimuovendo gli spazi.

Il segmento analyze-title viene aggiunto solo quando un titolo è fornito nell'azione analyze , o quando una pagina ha più chiamate analyze (in tal caso ogni risultato ottiene un suffisso unico per evitare conflitti).

Esempio

Dato un progetto con id: "deque" e una pagina con name: "Deque search" (nessun id), l'ID della pagina derivato automaticamente è Dequesearch. Una singola chiamata analyze senza titolo produce:

<output-dir>/deque/deque-Dequesearch.json

Con analyze the page with title "initial state":

<output-dir>/deque/deque-Dequesearch-initial state.json