Migreren naar Axe DevTools voor Web v4.x voor 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

Stappen voor migratie naar versie 4.x van Axe DevTools voor Web voor Node.js

Not for use with personal data

Axe DevTools NPM v4.x is een ingrijpende herziening van het hele project. De meest opvallende wijzigingen worden hieronder samengevat, gevolgd door meer specifieke wijzigingen voor relevante pakketten.

Samenvatting

De axe-devtools-* suite van npm-pakketten omvatte een herpositionering vanuit marketingperspectief en een unificatie van integratietools om specifieker te zijn voor de ontwikkelaarservaring.

Met dit in gedachten zijn alle pakketten hernoemd om gebruik te maken van de axe devtools namespace en zijn de binaries gecombineerd tot een enkel binarypakket.

Let op brekende wijzigingen

Gezien de herpositionering van de API is het eerlijk om te stellen dat migratie naar v4.0 inhoudt dat je deze migratiehandleiding stap voor stap moet volgen.

Omgevingsinstellingen

Er zijn geen veranderingen aan de standaardvereisten. De gewenste vereisten zijn als volgt:

  • Node LTS-versie
  • NPM voor npm-afhankelijkheden

Axe DevTools NPM-pakketten installeren

Zorg ervoor dat je toegang hebt tot Deque's registry. Zo niet, raadpleeg dan de installatiesinformatie voor je pakket:

Je kunt een van de onderstaande npm-pakketten installeren door ze op te nemen in het package.json-bestand.

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

De beschikbare npm-pakketten zijn:

Raadpleeg elk van de bovenstaande npm-pakketten voor gebruiksinstructies en gedetailleerde API-documentatie.

Optioneel kan men de vorige node-integraties deïnstalleren (voor gescoped of ongescoped pakketten) door de volgende commando's uit te voeren:

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

Opmerkelijke wijzigingen

Naast installatie- en gebruikswijzigingen met de beschreven componenten, omvatten enkele opmerkelijke wijzigingen:

  • De omgevingsvariabele voor het configureren van aangepaste regels is gewijzigd van ATTEST_PATH naar AXE_RULESET_PATH.
  • De standaardregels zijn veranderd. Axe DevTools voert een audit uit op een gegeven pagina met wcag2 als standaardregels. Er is geen verandering vereist door de eindgebruiker. Als men een andere regels wenst te configureren, kan men @axe-devtools/cli gebruiken om een andere regels te genereren of een axe-ruleset.json-bestand maken met hun gewenste regels.
  • Alle pakketten zullen gebruik maken van axe-core v4.0.X.
  • Axe DevTools WebdriverIO zal geen ondersteuning meer bieden voor WebdriverIO v4 en zal nu alleen nog ondersteuning bieden voor WebdriverIO v5 en v6.

Wijzigingen aan binaries

Attest-standards en Attest Reporter worden niet langer meegeleverd met binaries. Alle eerdere functionaliteiten van de binaries zullen als subcommando's worden opgenomen in @axe-devtools/cli. Voor Axe DevTools 4.0 zullen Attest-standards worden afgeschaft en zal er geen 4.0-versie van zijn.