Rapporten genereren

Wanneer je de Axe DevTools API's of de axe CLI gebruikt om te testen op toegankelijkheid, worden de resultaten opgeslagen als JSON-bestanden. Gebruik het axe reporter commando om die JSON-bestanden om te zetten naar HTML, JUnit XML, CSV of universele formatrapporten. U kunt ook resultaten filteren op type voordat u een rapport genereert.

• De axe reporter Commando
• Opties
• JSON-resultaten op schijf

De axe reporter Commando

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

De <results-dir> is de directory die de JSON-resultaatbestanden bevat. De optionele [dest-dir] is waar rapporten worden geschreven; je kunt ook --dest gebruiken om het te specificeren.

Genereer een CSV-rapport van JSON-resultaten:

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

Genereer rapporten in meerdere formaten tegelijk:

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

Opties

-d, --dest <path>

Specificeert de uitvoermap voor gegenereerde rapporten. Je kunt in plaats daarvan de bestemming opgeven als het tweede positionele argument.

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

Uitvoerformaat(en): html, junit (XML), csv, of universal. Om meerdere formaten in één run te genereren, geef ze gescheiden door komma's, spaties, puntkomma's of plustekens op. Spaties rond scheidingstekens worden genegeerd.

De universal waarde levert een JSON-bestand op in het Axe Universele Format, wat een standaardschema is dat wordt gedeeld tussen Axe-producten. Gebruik de begeleidende opties hieronder om te bepalen welke metadata in de uitvoer worden opgenomen.

--universal-ruleset <id>

Specificeert de regelsysteem-ID die in de metadata van de universele formatuitvoer moet worden opgenomen. Standaard is wcag2.1. Zie de regelsysteemtabel voor geldige waarden.

--universal-best-practices

Legt vast bestPracticesEnabled=true in de metadata van de universele formatuitvoer.

--filter <type(s)>

Filtert welke resultaatstypes in het rapport moeten worden opgenomen. Accepteert een of meer van: passes, violations, incomplete, inapplicable. Meerdere waarden scheiden met komma's en zonder spaties. Vereist --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>

Wanneer een resultaatsdirectory resultaten van meerdere browsers bevat, kun je deze optie gebruiken om een rapport te genereren van slechts één browser's resultaten. De naam moet overeenkomen met de browser die is gebruikt bij het uitvoeren van tests, bijvoorbeeld, chrome of firefox.

JSON-resultaten op schijf

Begrijpen hoe de Axe DevTools CLI JSON-resultaatbestanden benoemt en organiseert is nuttig bij het werken met het axe reporter commando of het programmatisch verwerken van resultaten.

Mapstructuur

Voor elk project in een spec-bestand worden de resultaten opgeslagen in een submap die is genoemd naar de idvan het project, binnen de uitvoermap die je opgeeft:

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

Deze submap wordt automatisch aangemaakt. Als deze al bestaat vanaf een vorige run, wordt deze gearchiveerd door hem te hernoemen naar <project-id>-<timestamp> voordat een nieuwe map wordt aangemaakt.

Bestandsnaamgeving

Elk JSON-resultaatbestand wordt genoemd met het project id en een paginatoestand afgeleid van de pagina id en de optionele title van de analyze actie:

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

De pagina id komt van het id veld in pageList. Als id niet expliciet is ingesteld op een pagina, wordt het automatisch afgeleid van de pagina name door spaties te verwijderen.

De analyze-title segment wordt alleen toegevoegd wanneer een titel wordt verstrekt in de analyze actie, of wanneer een pagina meerdere analyze oproepen heeft (in dat geval krijgt elk resultaat een unieke suffix om botsingen te voorkomen).

Voorbeeld

Gegeven een project met id: "deque" en een pagina met name: "Deque search" (geen expliciete id), wordt de automatisch afgeleide pagina-ID Dequesearch. Een enkele analyze oproep zonder titel produceert:

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

Met analyze the page with title "initial state":

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