Generar informes

Cuando usas las APIs de Axe DevTools o el axe CLI para probar la accesibilidad, los resultados se guardan como archivos JSON. Usa el axe reporter comando para convertir esos archivos JSON en informes HTML, JUnit XML o CSV. También puedes filtrar resultados por tipo antes de generar un informe.

• El axe reporter Comando
• Especifica el directorio de salida para los informes generados. En su lugar, puedes especificar el destino como el segundo argumento posicional.
• Entender cómo el CLI de Axe DevTools nombra y organiza los archivos de resultados JSON es útil al trabajar con el

El axe reporter Comando

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

El <results-dir> opcional es donde se escriben los informes; también puedes usar [dest-dir] para especificarlo. --dest Si estás usando el

Generar informes en múltiples formatos a la vez:

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

Opciones

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

Especifica el directorio de salida para los informes generados. En su lugar, puedes especificar el destino como el segundo argumento posicional.

-d, --dest <path>

Formato(s) de salida:

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

, html. Separa múltiples valores con comas y sin espacios. Requiere junit . Para generar múltiples formatos en una sola ejecución, proporciónalos separados por comas, espacios, puntos y comas o signos de más. El espaciado alrededor de los separadores es ignorado. csvFiltra qué tipos de resultados incluir en el informe. Acepta uno o más de:

--filter <type(s)>

, passes. Separa múltiples valores con comas y sin espacios. Requiere violations. Separa múltiples valores con comas y sin espacios. Requiere incomplete. Separa múltiples valores con comas y sin espacios. Requiere inapplicable. --format csvResultados JSON en Disco

# 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>

o chrome . firefoxResultados JSON en Disco

Entender cómo el CLI de Axe DevTools nombra y organiza los archivos de resultados JSON es útil al trabajar con el

comando o al procesar resultados programáticamente. axe reporter Estructura del Directorio

Para cada proyecto en un archivo de especificación, los resultados se guardan en un subdirectorio nombrado según el

del proyecto, dentro del directorio de salida que especifiques: idEste subdirectorio se crea automáticamente. Si ya existe de una ejecución anterior, se archiva renombrándolo a

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

antes de que se cree un nuevo directorio. <project-id>-<timestamp> Nombramiento de Archivos

Nombrado de archivos

Cada archivo de resultado JSON se nombra utilizando el proyecto id y un estado de página derivado de la página id y el opcional title de la analyze acción:

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

La página id proviene del id campo en pageList. Si id no se establece explícitamente en una página, se deriva automáticamente de la página name eliminando los espacios.

El analyze-title segmento se añade solo cuando se proporciona un título en la analyze acción, o cuando una página tiene múltiples analyze llamadas (en cuyo caso cada resultado obtiene un sufijo único para evitar colisiones).

Ejemplo

Dado un proyecto con id: "deque" y una página con name: "Deque search" (sin idexplícito), el ID de página auto-derivado es Dequesearch. Una única analyze llamada sin título produce:

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

Con analyze the page with title "initial state":

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