Migration zu Axe DevTools für Web v4.x für Node.js

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

Schritte zur Migration auf Version 4.x von Axe DevTools für Web für Node.js

Not for use with personal data

Axe DevTools NPM v4.x ist eine umfassende Neufassung des gesamten Projekts. Die bemerkenswertesten Änderungen sind unten zusammengefasst, gefolgt von spezifischeren Änderungen an relevanten Paketen.

Zusammenfassung

Die axe-devtools-*-Suite von npm-Paketen umfasste eine Neugestaltung aus einer Markenperspektive und das Ziel, die Integrationstools stärker auf die Entwicklererfahrung abzustimmen.

Vor diesem Hintergrund wurden alle Pakete umbenannt, um den axe devtools-Namensraum zu nutzen, und die Binärdateien wurden zu einem einzigen Binärpaket zusammengefasst.

Achten Sie auf breaking changes

Aufgrund der Umbenennung der API ist es wichtig zu betonen, dass die Migration zu v4.0 das Befolgen dieser Migrationsanleitung Schritt für Schritt erfordert.

Einrichtung der Umgebung

Es gibt keine Änderungen an den Standardanforderungen. Die gewünschten Anforderungen sind wie folgt:

Node LTS-Version
NPM für npm-Abhängigkeiten

Installation der Axe DevTools NPM-Pakete

Stellen Sie sicher, dass Sie Zugang zu Deque-Registry haben. Wenn nicht, beachten Sie die Installationsinformationen für Ihr Paket:

Sie können eines der unten aufgeführten npm-Pakete installieren, indem Sie es in die package.json-Datei aufnehmen.

npm install @axe-devtools/browser

// package.json
{
  "@axe-devtools/browser": "^4.0.0"
}

Die verfügbaren npm-Pakete sind:

Bitte beachten Sie die oben genannten npm-Pakete für Nutzungsanleitungen und detaillierte API-Dokumentationen.

Optional kann man die vorherigen Node-Integrationen (für gescoptete oder ungescoptete Pakete) deinstallieren, indem man die folgenden Befehle ausführt:

npm uninstall attest-js
npm uninstall @deque/attest-js

Beachtenswerte Änderungen

Neben den Änderungen bei der Installation und Nutzung der genannten Pakete sind einige erwähnenswerte Änderungen:

Die Umgebungsvariable zur Konfiguration benutzerdefinierter Regeln wurde von ATTEST_PATH zu AXE_RULESET_PATH geändert.
Das Standardregelwerk hat sich geändert. Axe DevTools prüft eine gegebene Seite mit wcag2 als Standardregelwerk. Für den Endbenutzer ist keine Änderung erforderlich. Wenn jemand ein anderes Regelwerk konfigurieren möchte, kann er @axe-devtools/cli verwenden, um ein anderes Regelwerk zu erstellen, oder eine axe-ruleset.json-Datei mit den gewünschten Regelwerken anlegen. Beachten Sie, dass sich der Standard seit dieser Veröffentlichung erneut geändert hat: Ab Axe DevTools für Web 4.5 (Dezember 2022) wurde das Standardregelwerk in allen Paketen auf WCAG 2.1 Level AA standardisiert, wobei die Best Practices deaktiviert sind. Siehe Anpassen von Regeln.
Alle Pakete nutzen axe-core v4.0.X.
Axe DevTools WebdriverIO wird WebdriverIO v4 nicht mehr unterstützen und nun nur noch WebdriverIO v5 und v6 unterstützen.

Änderungen an Binärdateien

Attest-Standards und Attest Reporter werden nicht mehr mit Binärdateien ausgeliefert. Alle bisherigen Funktionen der Binärdateien sind als Unterbefehle in @axe-devtools/cli enthalten. Für Axe DevTools 4.0 werden Attest-Standards veraltet sein und es wird keine 4.0-Version geben.