Berichte erstellen

Wenn Sie die Axe DevTools APIs oder die axe CLI verwenden, um Barrierefreiheit zu testen, werden die Ergebnisse als JSON-Dateien gespeichert. Verwenden Sie den axe reporter Befehl, um diese JSON-Dateien in HTML-, JUnit XML-, CSV- oder universelle Formatberichte umzuwandeln. Sie können die Ergebnisse auch nach Typ filtern, bevor Sie einen Bericht erstellen.

• Das axe reporter Befehl
• Optionen
• JSON-Ergebnisse auf der Festplatte

Das axe reporter Befehl

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

Das <results-dir> ist das Verzeichnis, das die JSON-Ergebnisdateien enthält. Die optionale [dest-dir] ist der Ort, an dem die Berichte gespeichert werden; Sie können auch --dest verwenden, um diesen anzugeben.

Erstellen Sie einen CSV-Bericht aus JSON-Ergebnissen:

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

Erstellen Sie Berichte gleichzeitig in mehreren Formaten:

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

Optionen

-d, --dest <path>

Gibt das Ausgabeverzeichnis für die erstellten Berichte an. Alternativ können Sie das Ziel als zweites Argument angeben.

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

Ausgabeformat(e): html, junit (XML), csv, oder universal. Um mehrere Formate in einem Durchlauf zu generieren, geben Sie diese durch Kommas, Leerzeichen, Semikolons oder Pluszeichen getrennt an. Leerzeichen um Trennzeichen werden ignoriert.

Das universal gibt eine JSON-Datei im Axe Universalformataus, das ein standardisiertes Schema ist, das in allen Axe-Produkten verwendet wird. Verwenden Sie die folgenden Begleitoptionen, um zu steuern, welche Metadaten im Output aufgezeichnet werden.

--universal-ruleset <id>

Gibt die Regelset-ID an, die in den Metadaten des universalen Format-Outputs aufgezeichnet werden soll. Standardmäßig wcag2.1. Siehe die Regelset-Tabelle für gültige Werte.

--universal-best-practices

Erfasst bestPracticesEnabled=true in den Metadaten des universal Format-Outputs.

--filter <type(s)>

Filtert, welche Ergebnistypen im Bericht enthalten sein sollen. Akzeptiert eines oder mehrere von: passes, violations, incomplete, inapplicable. Mehrere Werte werden mit Kommas und ohne Leerzeichen getrennt. Erfordert --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>

Wenn ein Ergebnisverzeichnis Ergebnisse von mehreren Browsern enthält, verwenden Sie diese Option, um einen Bericht nur aus den Ergebnissen eines Browsers zu erstellen. Der Name sollte dem beim Testen verwendeten Browser entsprechen, zum Beispiel chrome oder firefox.

JSON-Ergebnisse auf der Festplatte

Es ist nützlich zu verstehen, wie die Axe DevTools CLI JSON-Ergebnisdateien benennt und organisiert, wenn Sie mit dem axe reporter Befehl arbeiten oder Ergebnisse programmatisch verarbeiten.

Verzeichnisstruktur

Für jedes Projekt in einer Spec-Datei werden die Ergebnisse in einem Unterverzeichnis gespeichert, das nach dem Namen des Projekts benannt ist id, innerhalb des von Ihnen angegebenen Ausgabeverzeichnisses:

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

Dieses Unterverzeichnis wird automatisch erstellt. Wenn es bereits aus einem vorherigen Lauf existiert, wird es archiviert, indem es in <project-id>-<timestamp> umbenannt wird, bevor ein neues Verzeichnis erstellt wird.

Dateibenennung

Jede JSON-Ergebnisdatei wird unter Verwendung des Projekts id und eines Seitensatzes benannt, der von der Seite abgeleitet wird id und der optionalen title aus der analyze Aktion:

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

Die Seite id stammt aus dem id Feld in pageList. Wenn id nicht explizit auf einer Seite gesetzt ist, wird es automatisch von der Seite abgeleitet name indem die Leerzeichen entfernt werden.

Das analyze-title Segment wird nur angehängt, wenn ein Titel in der analyze Aktion bereitgestellt wird oder wenn eine Seite mehrere analyze Aufrufe hat (in diesem Fall erhält jedes Ergebnis ein eindeutiges Suffix, um Kollisionen zu vermeiden).

Beispiel

Angenommen, ein Projekt mit id: "deque" und eine Seite mit name: "Deque search" (kein explizites id), dann ist die automatisch abgeleitete Seiten-ID Dequesearch. Ein einzelner analyze Aufruf ohne Titel erzeugt:

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

Mit analyze the page with title "initial state":

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