axe DevTools Reporter CLI
Erstellen Sie eigenständige Berichte von axe DevTools Mobile, um sie mit Ihrem Team zu teilen – ob lizenzierter Benutzer oder nicht.
Die CLI von axe DevTools Reporter hat die in der CLI von axe DevTools verfügbare Berichtsfunktion übernommen und in ein leichtes, eigenständiges Berichtstool integriert.
Die Reporter-CLI erfordert axe DevTools Mobile JSON-Dateien zum Erstellen eines Berichts. JSON-Dateien können aus zwei Quellen bezogen werden:
- Empfohlen für den persönlichen Gebrauch: Exportieren von Scans aus dem axe DevTools Mobile-Dashboard
- Empfohlen für CI/CD-Pipeline: Ergebnisse lokal innerhalb Ihres automatisierten Testlaufs speichern
Haben Sie die Reporter-CLI bereits installiert? Sehen Sie sich unsere nachfolgende Anleitung zum Generieren von Berichten mit CI/CD an.
Verwenden Sie bereits die axe DevTools CLI?
axe DevTools CLI unterstützt das Generieren von HTML-Berichten aus axe DevTools Mobile-Scans. Stellen Sie der CLI ein Verzeichnis zur Verfügung, das Ihre mobilen Scans als JSON-Dateien enthält.
Hinweis: Weitere Informationen zum Tool finden Sie in der axe DevTools CLI-Dokumentation.
Ersteinrichtung
Download über npm
Axe DevTools Reporter CLI ist über Deque's Artifactory als npm-Paket verfügbar. Befolgen Sie unsere Anleitung zum Einrichten Ihres npm-Registers für den Zugriff auf Axe DevTools Mobile.
Direkter Download
Suchen Sie in den folgenden Unterabschnitten nach Ihrem Betriebssystem. Sobald die Axe DevTools Reporter CLI von Deque's Artifactory heruntergeladen wurde, öffnen Sie die Befehlszeile und navigieren Sie zum Speicherort der ausführbaren Datei. Verwenden Sie den Befehl unter dem Download-Link, um die Installation zu testen.
Administratormodus
Abhängig von der Konfiguration Ihres Computers müssen Sie möglicherweise den Administratormodus verwenden.
Globale Installation aktivieren
Stellen Sie die axe DevTools Reporter CLI global zur Verfügung, indem Sie sie in einem Verzeichnis im $PATH Ihres Systems platzieren. Sie können sehen, welche Verzeichnisse sich im $PATH Ihres Systems befinden, indem Sie `echo $PATH`ausführen.
Ihr Download sollte eine ausführbare Datei sein. Möglicherweise müssen Sie chmod +x <name>
ihn auf Mac- oder Linux-Rechnern im Terminal ausführen, um dies zu erreichen.
Unter Windows
Testen Sie die Installation mit:
./reporter-cli-win.exe --help
Unter Linux
Testen Sie die Installation mit:
./reporter-cli-linux --help
Unter macOS
Testen Sie die Installation mit:
./reporter-cli-macos --help
Berichte erstellen
Sobald Sie alle axe DevTools Mobile-Scans als JSON-Dateien gesammelt haben, können Sie einen Bericht erstellen. Stellen Sie sicher, dass sich alle Scans in einem Verzeichnis befinden, und führen Sie dann den folgenden Befehl aus, um die HTML-Berichte zu generieren:
axe-devtools-reporter <devtools-results-directory> <output-directory> --format=html
Das Ausgabeverzeichnis ist optional und wenn es nicht angegeben wird, werden die Berichte in ./axe-devtools-reporter
gespeichert.
Dateinamen werden aus dem Scan-Namen und dem Analysezeitstempel des Scans abgeleitet. ${scanName}-axe-result-${timestamp}.html
Vergessen Sie nicht, zu überprüfen executive-report.html
, um die kombinierten Ergebnisse aller Scans in der Suite anzuzeigen.
Ausgabeformat
Zusätzlich zum HTML-Bericht können Sie die Daten auch im CSV- oder XML/JUnit-Format exportieren.
HTML:
axe-devtools-reporter <devtools-results-directory> <output-directory> --format=html
XML/JUnit:
axe-devtools-reporter <devtools-results-directory> <output-directory> --format=junit
CSV:
axe-devtools-reporter <devtools-results-directory> <output-directory> --format=csv