Gerar Relatórios

Quando você utiliza as APIs do Axe DevTools ou a axe CLI para testar acessibilidade, os resultados são salvos como arquivos JSON. Use o axe reporter comando para converter esses arquivos JSON em relatórios nos formatos HTML, JUnit XML, CSV ou universal. Você também pode filtrar resultados por tipo antes de gerar um relatório.

• O segmento axe reporter Comando
• Opções
• Resultados JSON no Disco

O segmento axe reporter Comando

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

O segmento <results-dir> é o diretório contendo arquivos de resultados JSON. O opcional [dest-dir] é onde os relatórios são escritos; você também pode usar --dest para especificá-lo.

Gerar um relatório CSV a partir de resultados JSON:

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

Gerar relatórios em múltiplos formatos de uma só vez:

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

Opções

-d, --dest <path>

Especifica o diretório de saída para os relatórios gerados. Você também pode especificar o destino como o segundo argumento posicional.

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

Formato(s) de saída: html, junit (XML), csv, ou universal. Para gerar múltiplos formatos de uma vez, forneça-os separados por vírgulas, espaços, ponto e vírgula ou sinais de mais. O espaçamento ao redor dos separadores é ignorado.

O segmento universal valor gera um arquivo JSON no Formato Universal Axe, que é um esquema padrão compartilhado entre os produtos Axe. Use as opções complementares abaixo para controlar quais metadados são registrados na saída.

--universal-ruleset <id>

Especifica o ID do conjunto de regras a ser registrado nos metadados da saída em formato universal. O padrão é wcag2.1. Veja a tabela de conjuntos de regras para valores válidos.

--universal-best-practices

Registra bestPracticesEnabled=true nos metadados da saída em formato universal.

--filter <type(s)>

Filtra quais tipos de resultados incluir no relatório. Aceita um ou mais dos seguintes: passes, violations, incomplete, inapplicable. Separe múltiplos valores com vírgulas e sem espaços. Requer --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 um diretório de resultados contém resultados de múltiplos navegadores, use esta opção para gerar um relatório somente dos resultados de um navegador. O nome deve coincidir com o navegador usado ao executar os testes, por exemplo, chrome ou firefox.

Resultados JSON no Disco

Entender como o CLI do Axe DevTools nomeia e organiza arquivos de resultados JSON é útil ao trabalhar com o axe reporter comando ou processar resultados programaticamente.

Estrutura de Diretório

Para cada projeto em um arquivo de especificação, os resultados são salvos em um subdiretório nomeado após o id, dentro do diretório de saída que você especifica:

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

Este subdiretório é criado automaticamente. Se ele já existir de uma execução anterior, ele é arquivado ao ser renomeado para <project-id>-<timestamp> antes de um novo diretório ser criado.

Nomeação de Arquivos

Cada arquivo de resultado JSON é nomeado usando o projeto id e um estado de página derivado da página id e o opcional title da ação analyze :

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

A página id vem do campo id em pageList. Se id não for explicitamente definido em uma página, ele é derivado automaticamente da página name removendo espaços.

O segmento analyze-title é anexado apenas quando um título é fornecido na ação analyze , ou quando uma página tem várias chamadas analyze (nesse caso, cada resultado recebe um sufixo único para evitar colisões).

Exemplo

Dado um projeto com id: "deque" e uma página com name: "Deque search" (sem idexplícito), o ID de página auto-derivado é Dequesearch. Uma única chamada analyze sem título produz:

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

Com analyze the page with title "initial state":

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