Konfiguration von Axe DevTools für Web CLI

This page is not available in the language you requested. You have been redirected to the English version of the page.

Link to this page copied to clipboard

Legen Sie Browser, Timeout, Fenstergröße und andere dauerhafte Standardeinstellungen für Axe DevTools für Web CLI fest.

Not for use with personal data

Die in diesem Artikel beschriebenen Flags sind verfügbar für axe <url>, axe spec und axe bulk-spec. Wenn Sie eines dieser Flags setzen, wird der Wert in der Einstellungsdatei gespeichert und für alle nachfolgenden Durchläufe als Standard verwendet. Um Einstellungen interaktiv anzuzeigen oder zu ändern, einschließlich der Zurücksetzung von Werten, die kein entsprechendes Flag haben, verwenden Sie axe config-selenium.

Browseroptionen

`--accept-untrusted`

Weist den Browser an, nicht vertrauenswürdige SSL-Zertifikate zu akzeptieren. Verwenden Sie dies beim Testen von Seiten auf lokalen Entwicklungsservern oder internen Umgebungen, die selbstsignierte Zertifikate verwenden. Das Setzen dieses Flags speichert acceptUntrustedCertificates: true in der Einstellungsdatei. Um es auf false zurückzusetzen, führen Sie axe config-selenium aus und antworten Sie mit Nein, wenn Sie dazu aufgefordert werden, oder bearbeiten Sie die Voreinstellungsdatei direkt.

axe <url> --accept-untrusted

`--browser <name>`

Gibt an, welcher Browser verwendet werden soll. Der entsprechende WebDriver muss auf Ihrem $PATH installiert und verfügbar sein. Gültige Werte sind: firefox (Standard), chrome, safari, edge, ie.

axe <url> --browser chrome

Wenn bei Ihrem ersten Durchlauf ein Browser-Startfehler auftritt, ist möglicherweise GeckoDriver (Firefox's WebDriver) nicht installiert. Versuchen Sie stattdessen --browser chrome, das in der Regel auf den meisten Systemen ohne zusätzliche Einrichtung funktioniert.

Das Setzen dieses Flags speichert den Browsernamen in der Einstellungsdatei. Alle nachfolgenden Durchläufe, einschließlich der ohne --browser, verwenden den gespeicherten Browser. Um den gespeicherten Browser zu ändern, führen Sie axe config-selenium aus und wählen Sie einen anderen Browser im Dialog, oder bearbeiten Sie die Einstellungsdatei direkt.

`--headless`

Startet den Browser im Headless-Modus (kein sichtbares Fenster). Der Standard ist false.

axe <url> --headless

`--remote-server <url>`

Verbindet sich mit einem Remote-WebDriver-Server anstelle des Starts eines lokalen Browsers. Der Server muss einen kompatiblen W3C-WebDriver-Endpunkt bereitstellen, wie z. B. ein Selenium Grid, BrowserStack oder Sauce Labs Remote.

axe <url> --remote-server https://hub.browserstack.com/wd/hub

`--window-size <width,height>`

Legt die Browserfenstergröße in Pixel fest. Dies steuert auch die Viewport-Größe im Headless-Modus, was nützlich für das Testen von responsiven Layouts ist.

axe <url> --window-size 1280,900

Zeiteinstellungen

`--page-timeout <ms>`

Maximale Zeit in Millisekunden (ms), um auf das Laden einer Seite zu warten, bevor ein Fehler auftritt. Der Standardwert ist 60.000 ms (60 Sekunden). Erhöhen Sie diesen Wert für Seiten mit langsamer Ladezeit oder in Netzwerken mit hoher Latenz.

axe <url> --page-timeout 120000

`--post-analyze-pause <ms>`

Zeit in Millisekunden zum Pausieren nach Abschluss einer Analyse, bevor zur nächsten Aktion in einem Workflow übergegangen wird. Standardwert ist 2.000 ms (2 Sekunden).

axe spec workflow.yml --post-analyze-pause 5000

`--post-get-pause <ms>`

Zeit in Millisekunden zum Pausieren nach dem Laden einer Seite und bevor der Scan beginnt. Standardwert ist 2.000 ms (2 Sekunden). Erhöhen Sie diesen Wert, wenn dynamische Inhalte mehr Zeit benötigen, um vor dem Start des Scans zu rendern.

axe <url> --post-get-pause 5000

`--post-script-pause <ms>`

Zeit in Millisekunden zum Pausieren nach der Ausführung einer Workflow-Skriptaktion und bevor zur nächsten Aktion übergegangen wird. Standardwert ist 2.000 ms (2 Sekunden).

axe spec workflow.yml --post-script-pause 5000

`--script-timeout <ms>`

Maximale Zeit in Millisekunden, um auf die Fertigstellung eines Workflow-Skripts zu warten. Der Standardwert ist 60.000 ms (60 Sekunden).

axe spec workflow.yml --script-timeout 120000

Nutzungsverfolgung

Axe DevTools CLI enthält die @deque/metrics-library, die anonyme Nutzungsdaten an Deque sendet. Diese Daten umfassen aggregierte Informationen wie Verstoßzählungen, Regelzählungen und die axe-core Engine-Version. Sie enthalten keine URLs, Seiteninhalte oder personenbezogene Informationen.

Ein unterschiedliche ID ist ein Wert, der in der Voreinstellungsdatei gespeichert wird und verwendet wird, um Ereignisse über mehrere CLI-Durchläufe hinweg zu korrelieren, ohne den Benutzer zu identifizieren. Sie können das Tracking mit den unten stehenden Optionen ändern oder deaktivieren. Um diese Werte ohne Verwendung der CLI festzulegen, verwenden Sie die Nutzungsdienste-Umgebungsvariablen.

`--enable-tracking <state>`

Aktiviert oder deaktiviert das Senden von Nutzungsdaten an die Metrikenbibliothek. Tracking ist standardmäßig aktiviert; übergeben Sie false, um es zu deaktivieren. Die entsprechende Umgebungsvariable ist AXE_TRACK_USAGE — siehe Nutzungsdienste-Umgebungsvariablen.

axe <url> --enable-tracking false

`--set-distinct-id <id>`

Ändert die eindeutige ID, die zur Korrelation von Nutzungsevents verwendet wird. Die ID wird in der Voreinstellungsdatei gespeichert und über Laufzeiten hinweg verwendet. Die entsprechende Umgebungsvariable ist AXE_DISTINCT_ID — siehe Nutzungsdienste-Umgebungsvariablen.

axe <url> --set-distinct-id my-team-id

`--set-tracking-url <url>`

Ändert den Endpunkt, an den Nutzungsmetriken gesendet werden. Verwenden Sie dies, wenn Ihre Organisation Telemetriedaten über einen internen Proxy leitet. Die entsprechende Umgebungsvariable ist AXE_METRICS_URL — siehe Nutzungsdienste-Umgebungsvariablen.

axe <url> --set-tracking-url https://metrics.example.com/collect

Nutzungsdienste-Umgebungsvariablen

Zusätzlich zu den CLI-Flags können Sie den Nutzungsdienst konfigurieren und Eigenschaften für gemeldete Ereignisse mit Umgebungsvariablen festlegen. Die Spalte Kann überschreiben gibt an, ob der Wert der Umgebungsvariable einen bereits programmatisch über die Metrikbibliothek gesetzten Wert überschreiben kann. Ein Bindestrich (—) gibt an, dass das Konzept nicht auf diese Variable anwendbar ist.

Name	Typ	Kann überschrieben werden	Beschreibung
`AXE_DISTINCT_ID`	String	—	Ein UUID-Identifikator, der für den angemeldeten Benutzer gleich bleibt (außer er wird neu generiert). In Ruby heißt diese Variable `DEQUE_DISTINCT_ID`.
`AXE_INCLUDE_TEST_RESULTS`	Boolean	—	Setzen Sie `true`, um die vollständigen axe-core-Ergebnisse im `testResults`-Objekt jedes Ereignisses einzuschließen (Standard ist `false`). Wird nur von der CLI und den Node.js-APIs unterstützt.
`AXE_METRICS_URL`	String	—	Die URL des REST-Nutzungsendpunkts (Standard ist `https://usage.deque.com`)
`AXE_TRACK_USAGE`	Boolean	—	Setzen Sie `false`, um das Reporting des Nutzungsdienstes zu deaktivieren. Das Reporting ist standardmäßig aktiviert.
`AXE_APPLICATION`	String	false	Die Anwendung, die verwendet wurde, um Barrierefreiheitsfehler zu überprüfen
`AXE_DEV_INSTANCE`	Boolean	true	Zeigt an, ob dieses Ereignis durch die Aktionen eines Softwareentwicklers entstanden ist. Nützlich zum Markieren und späteren Entfernen von Ereignissen, die während der Entwicklung oder des Testens protokolliert wurden.
`AXE_DEPARTMENT`	String	true	Die Abteilung des Benutzers innerhalb der Organisation
`AXE_KEYCLOAK_ID`	String	false	Die Keycloak-ID des Benutzers
`AXE_LOGGED_IN`	Boolean	false	Zeichnet auf, ob der Benutzer im zu testenden Anwendung angemeldet ist
`AXE_ORGANIZATION`	String	true	Die Organisation des Benutzers. Um Ihre Nutzung in Axe Reports anzuzeigen, setzen Sie dies auf die ID Ihrer Organisation (kontaktieren Sie Deque, um diese zu erhalten).
`AXE_SESSION_ID`	String	false	Ein UUID, das die Sitzung des Benutzers identifiziert
`AXE_USER_ID`	String	false	Die Identität eines bestimmten Benutzers, wie eine E-Mail-Adresse, ein Name oder eine Login-ID. Axe Reports zählt anhand dieses Wertes eindeutige Benutzer.
`AXE_USER_JOB_ROLE`	String	false	Die Rolle des Benutzers im Beruf
`AXE_USER_STATUS`	String	false	Statusinformationen, die Sie mit dem Benutzer verknüpfen möchten

`axe config-selenium`

Verwenden Sie axe config-selenium, um Standardwerte interaktiv zu konfigurieren. Sie werden aufgefordert, Werte für Browser, Timeout und andere Einstellungen einzugeben. Ihre Antworten werden in der Voreinstellungsdatei gespeichert und somit die Standards für alle nachfolgenden CLI-Durchläufe.

$ axe config-selenium
? Choose browser for running automated tests: (Use arrow keys)
? Choose browser for running automated tests: chrome
? Enter a value for pageLoadTimeout: 60000
? Enter a value for setScriptTimeout: 60000
? Accept untrusted ssl certs: Yes
? Enter a value for postGetPause: 2000
? Enter a value for postScriptPause: 2000
? Enter a value for postAnalysisPause: 2000
? Launch browser in headless mode: No

Results saved to ~/.config/preferences/com.deque.axe.devtools.cli.pref

Um die aktuell gespeicherten Einstellungen anzuzeigen, ohne den interaktiven Dialog zu betreten, verwenden Sie das --show-Flag:

axe config-selenium --show

Einstellungsdatei

Alle konfigurierbaren Standardwerte werden in einer JSON-Datei gespeichert unter:

~/.config/preferences/com.deque.axe.devtools.cli.pref

Eine typische Datei sieht so aus:

{
  "selenium": {
    "acceptUntrustedCertificates": false,
    "browser": "firefox",
    "headless": false,
    "pageLoadTimeout": 60000,
    "postAnalysisPause": 2000,
    "postGetPause": 2000,
    "postScriptPause": 2000,
    "setScriptTimeout": 60000
  }
}

Sie können diese Datei direkt bearbeiten, als Alternative zur Verwendung von axe config-selenium oder zum Übergeben von Flags in der Befehlszeile. Dies ist nützlich, um boolesche Werte wie acceptUntrustedCertificates zurückzusetzen, ohne den interaktiven Dialog auszuführen.