Migration zu axe DevTools for 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 for Web für Node.js

Not for use with personal data

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

Zusammenfassung

Die axe-devtools-*-Suite von npm-Paketen beinhaltete eine Rebranding-Perspektive sowie eine Vereinheitlichung der Integrationstools, um die Entwicklererfahrung zu verbessern.

Mit diesem Gedanken wurden alle Pakete neu gebrandet, um den axe devtools Namespace zu nutzen, und die Binärdateien wurden zu einem einzigen Binärpaket kombiniert.

Vorsicht vor Breaking Changes

Angesichts der Umbenennung der API ist es fair, darauf hinzuweisen, dass die Migration auf v4.0 das Befolgen dieses Migrationsleitfadens Schritt für Schritt beinhaltet.

Einrichtung der Umgebung

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

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

Installieren von axe DevTools NPM-Paketen

Stellen Sie sicher, dass Sie Zugriff auf Deque's Registry haben. Wenn nicht, lesen Sie die Installationsinformationen für Ihr Paket:

Sie können jedes der folgenden npm-Pakete installieren, indem Sie sie in die Datei package.json aufnehmen.

npm install @axe-devtools/browser

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

Die verfügbaren npm-Pakete sind:

Bitte beachten Sie jedes der oben genannten npm-Pakete für Verwendungsanweisungen und eine ausführliche API-Dokumentation.

Optional können die vorherigen Node-Integrationen (für Pakete mit oder ohne Gültigkeitsbereich) durch Ausführen der folgenden Befehle deinstalliert werden:

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

Bemerkenswerte Änderungen

Neben den Installations- und Nutzungsänderungen bei den beschriebenen Gems sind hier einige nennenswerte Änderungen zu nennen:

– Die Umgebungsvariable zum Konfigurieren benutzerdefinierter Regeln wurde von ATTEST_PATH zu AXE_RULESET_PATH geändert. – Der Standardregelsatz hat sich geändert. Axe DevTools prüft eine bestimmte Seite mit wcag2 als Standardregelsatz. Es sind keine Änderungen seitens des Endbenutzers erforderlich. Wenn Sie einen anderen Regelsatz konfigurieren möchten, können Sie @axe-devtools/cli verwenden, um einen anderen Regelsatz zu generieren, oder eine Datei axe-ruleset.json mit den gewünschten Regelsätzen erstellen. – Alle Pakete nutzen axe-core v4.0.X.

Axe DevTools WebdriverIO unterstützt WebdriverIO v4 nicht mehr und unterstützt jetzt nur noch WebdriverIO v5 und v6.

Änderungen an Binärdateien

Attest-Standards und Attest Reporter werden nicht mehr mit Binärdateien ausgeliefert. Die gesamte bisherige Funktionalität der Binärdateien wird als Unterbefehle in @axe-devtools/cli enthalten sein. Für axe DevTools 4.0 werden Atteststandards veraltet und es wird keine Version 4.0 geben.