Migrazione a Axe DevTools per Web v4.x per Node.js
Passaggi per la migrazione alla versione 4.x di Axe DevTools per Web per Node.js
Axe DevTools NPM v4.x è una riscrittura importante dell'intero progetto. I cambiamenti più significativi sono riassunti di seguito, seguiti da modifiche più specifiche ai pacchetti pertinenti.
Riepilogo
La suite axe-devtools-* di pacchetti npm ha comportato un rebranding, oltre a unificare gli strumenti di integrazione per essere più specifici all'esperienza degli sviluppatori.
Con questo in mente, tutti i pacchetti sono stati rinominati per utilizzare il namespace axe devtools e i binari sono stati unificati in un unico pacchetto binario.
Attenzione ai cambiamenti critici
A causa del rebranding dell'API, è giusto sottolineare che la migrazione alla v4.0 richiede di seguire questa guida alla migrazione passo dopo passo.
Configurazione dell'ambiente
Non ci sono cambiamenti nei requisiti di default. I requisiti desiderati sono i seguenti:
Installazione dei pacchetti NPM di Axe DevTools
Assicurati di avere accesso a Deque's registry. Se non lo hai, consulta le informazioni di installazione per il tuo pacchetto:
Puoi installare qualsiasi dei pacchetti npm sottostanti includendoli nel file package.json.
npm install @axe-devtools/browser// package.json
{
"@axe-devtools/browser": "^4.0.0"
}I pacchetti npm disponibili sono:
- Axe DevTools CLI
- Axe DevTools Puppeteer
- Axe DevTools Reporter
- Axe DevTools WebdriverIO
- Axe DevTools WebDriverJS
Si prega di consultare ciascuno dei pacchetti npm suddetti per le istruzioni d'uso e la documentazione API dettagliata.
Facoltativamente, è possibile disinstallare le precedenti integrazioni node (per pacchetti con o senza scope) eseguendo i comandi sotto:
npm uninstall attest-js
npm uninstall @deque/attest-jsModifiche di rilievo
Oltre ai cambiamenti di installazione e utilizzo dei gem outline, alcune modifiche di rilievo includono:
- La variabile d'ambiente per la configurazione di regole personalizzate è stata cambiata da
ATTEST_PATHaAXE_RULESET_PATH. - Il set di regole di default è cambiato. Axe DevTools esegue un audit di una pagina data con
wcag2come set di regole di default. Non è richiesto alcun cambiamento da parte dell'utente finale. Se si desidera configurare un set di regole diverso, si può utilizzare@axe-devtools/cliper generare un set diverso o creare un file axe-ruleset.json con i set di regole desiderati. - Tutti i pacchetti utilizzeranno axe-core v4.0.X.
- Axe DevTools WebdriverIO non supporterà più WebdriverIO v4 e ora supporterà solo WebdriverIO v5 e v6.
Modifiche ai binari
Attest-standards e Attest Reporter non saranno più forniti con i binari. Tutte le funzionalità precedenti dei binari saranno incluse in @axe-devtools/cli come sottomandi. Per Axe DevTools 4.0, Attest-standards sarà deprecato e non avrà una release 4.0.
