Berichte erstellen

Wenn Sie die Axe DevTools APIs oder das axe CLI verwenden, um auf 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 zu konvertieren. Sie können die Ergebnisse auch nach Typ filtern, bevor Sie einen Bericht erstellen.

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

Der axe reporter-Befehl

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

Der <results-dir> ist das Verzeichnis, das die JSON-Ergebnisdateien enthält. Der optionale [dest-dir] ist der Speicherort, an dem die Berichte geschrieben werden; Sie können auch --dest verwenden, um ihn 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 Durchgang zu generieren, geben Sie sie durch Kommas, Leerzeichen, Semikolons oder Pluszeichen getrennt an. Leerzeichen um die Trennzeichen werden ignoriert.

Der universal-Wert gibt eine JSON-Datei im Axe Universalformat aus, das ein standardisiertes Schema ist, das in allen Axe-Produkten verwendet wird. Verwenden Sie die folgenden Begleitoptionen, um zu steuern, welche Metadaten in der Ausgabe aufgezeichnet werden.

--universal-ruleset <id>

Gibt die Regelwerks-ID an, die in den Metadaten der Ausgabe im universellen Format aufgezeichnet werden soll. Standardwert ist wcag2.1. Siehe die Regelset-Tabelle für gültige Werte.

--universal-best-practices

Zeichnet bestPracticesEnabled=true in den Metadaten der Ausgabe im universellen Format auf.

--filter <type(s)>

Filtert, welche Ergebnistypen in den Bericht aufgenommen werden sollen. Akzeptiert eines oder mehrere von: passes, violations, incomplete, inapplicable. Mehrere Werte werden durch Kommas 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 mit dem Browser übereinstimmen, der beim Ausführen der Tests verwendet wurde, beispielsweise chrome oder firefox.

JSON-Ergebnisse auf der Festplatte

Das Verständnis, wie das Axe DevTools CLI JSON-Ergebnisdateien benennt und organisiert, ist nützlich, wenn Sie mit dem axe reporter-Befehl arbeiten oder Ergebnisse programmatisch verarbeiten.

Verzeichnisstruktur

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

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

Dieses Unterverzeichnis wird automatisch erstellt. Wenn es aus einem vorherigen Durchlauf bereits 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 Projekt-id und eines Seitenstatus benannt, der aus der Seiten-id und dem optionalen title aus der analyze-Aktion abgeleitet wird:

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

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

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

Beispiel

Bei einem Projekt mit id: "deque" und einer Seite mit name: "Deque search" (keine explizite id) wird 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