Come i risultati di accessibilità JSON vengono archiviati sul disco
Denominazione di file e directory con Risultati di accessibilità JSON
Il formato dei dati dei risultati è composto da quanto segue:
- Il modo in cui axe DevTools CLI utilizza le directory del file system per organizzare i file che contengono i dati per un singolo stato di pagina,
- L'algoritmo che axe DevTools CLI utilizza per nominare questi singoli file e
- Il formato dei dati JSON all'interno di ciascun file.
La struttura della directory
La funzione di API del reporter memorizzerà i file di output nella cartella che viene passata come parametro opzionale dirPath
alla chiamata di funzione AxeDevTool.report(testCaseName[, dirPath])
. Se non viene specificato alcun valore, verrà utilizzata la directory di lavoro corrente.
axe DevTools CLI memorizza i risultati in una cartella denominata con il valore della proprietà id
nel file di specifiche CLI. Questa directory viene creata automaticamente quando viene chiamata la CLI. Se la cartella esiste già, viene rinominata in id-{Date.now().toString()}
e poi viene creata una nuova cartella vuota con la proprietà id
.
Ogni singolo risultato dell'analisi viene memorizzato in un .json
file all'interno di questa cartella.
Nomi dei file dei risultati
Il nome di ogni singolo file viene formato utilizzando il valore della proprietà id
(nel file spec nella CLI o passato al reporter tramite l'API) e il valore della pageState
proprietà. Il nome completo del file viene costruito utilizzando questi due valori nel modo seguente {id}-{pageState}.json
.
Quindi se id
è deque
e pageState
è homepage-initial
, il nome file risultante sarà deque-homepage-initial.json
.
In CLI, pageState
viene costruito dalla combinazione di name
proprietà della voce nell' pageList
e del valore di title
proprietà nell' analyze
istruzione. Questi vengono combinati concatenando i due valori, separati da un trattino, come avverrebbe utilizzando la seguente stringa modello JavaScript: ${name}-${title}
L'API del reporter utilizza il parametro id
che viene passato alla chiamata di funzione reporter.logTestResult
come valore pageSate
.