Cómo se almacenan los resultados de accesibilidad JSON en el disco
Nombramiento de archivos y directorios con Resultados de accesibilidad JSON
El formato de los datos de resultados consta de lo siguiente:
- La forma en que axe DevTools CLI utiliza los directorios del sistema de archivos para organizar los archivos que contienen los datos de un estado de página individual,
- El algoritmo que utiliza axe DevTools CLI para nombrar estos archivos individuales y
- El formato de los datos JSON dentro de cada archivo.
La estructura del directorio
La API del reportero almacenará los archivos de salida en la carpeta que se pasa como dirPath
parámetro opcional a la AxeDevTool.report(testCaseName[, dirPath])
llamada de función. Si no se proporciona ningún valor, se utilizará el directorio de trabajo actual.
Axe DevTools CLI almacena los resultados de salida en una carpeta cuyo nombre es id
la propiedad en el archivo de especificación CLI. Este directorio se crea automáticamente cuando se llama CLI. Si la carpeta ya existe, se le cambia el nombre a id-{Date.now().toString()}
y luego se crea una nueva carpeta vacía con id
la propiedad.
Cada resultado de análisis individual se almacena en un .json
archivo dentro de esta carpeta.
Nombres de los archivos de resultados
El nombre de cada archivo individual se forma utilizando el valor de la propiedad id
(en el archivo de especificaciones en CLI o pasado al reportero a través de la API) y el valor de pageState
. El nombre de archivo completo se construye utilizando estos dos valores de la siguiente manera {id}-{pageState}.json
.
Si id
es deque
y pageState
es homepage-initial
, el nombre de archivo resultante sería deque-homepage-initial.json
.
En CLI, pageState
se construye mediante la combinación de la propiedad name
de la entrada en la pageList
y el valor de la propiedad title
en la declaración analyze
. Estos se combinan concatenando los dos valores, separados por un guión, como sería el caso utilizando la siguiente cadena de plantilla de JavaScript: ${name}-${title}
La API del reportero utiliza el parámetro id
que se pasa a la llamada de función reporter.logTestResult
como valor pageSate
.