Migrazione ad axe DevTools per Web v4.x per 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

Passaggi per la migrazione alla versione 4.x di axe DevTools per Web per Node.js

Not for use with personal data

Axe DevTools NPM v4.x è una riscrittura importante dell'intero progetto. Di seguito sono riepilogate le modifiche più importanti, seguite da modifiche più specifiche ai pacchetti rilevanti.

Riepilogo

La suite di pacchetti npm axe-devtools-* ha comportato un rebranding e l'unificazione degli strumenti di integrazione per migliorare l'esperienza degli sviluppatori.

Tenendo presente ciò, tutti i pacchetti sono stati rinominati per utilizzare lo spazio dei nomi axe devtools e i file binari sono stati combinati in un unico pacchetto binario.

Attenzione alle modifiche che interrompono la compatibilità

Dato il rebranding dell'API, è giusto sottolineare che la migrazione alla versione 4.0 comporta il rispetto di questa guida alla migrazione passo dopo passo

Configurazione dell'ambiente

Non ci sono cambiamenti ai requisiti predefiniti. I requisiti desiderati sono i seguenti:

[Nodo][] Versione LTS
NPM per le dipendenze npm

Installazione dei pacchetti NPM di axe DevTools

Assicurati di avere accesso al [registro di Deque][]. In caso contrario, fare riferimento alle informazioni di installazione del pacchetto:

È possibile 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:

Per istruzioni sull'utilizzo e documentazione API dettagliata, fare riferimento a ciascuno dei pacchetti npm sopra indicati.

Facoltativamente, è possibile disinstallare le precedenti integrazioni Node.js (per pacchetti con o senza ambito) eseguendo i comandi seguenti:

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

Cambiamenti degni di nota

Oltre alle modifiche all'installazione e all'utilizzo delle gemme descritte, ecco alcune modifiche degne di nota:

La variabile ambiente per la configurazione delle regole personalizzate è stata modificata da ATTEST_PATH a AXE_RULESET_PATH.
Il set di regole predefinito è cambiato. Axe DevTools esegue l'audit di una determinata pagina con wcag2 come set di regole predefinito. Non è richiesta alcuna modifica da parte dell'utente finale. Se si desidera configurare un set di regole diverso, è possibile utilizzare @axe-devtools/cli per generare un set di regole 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 verranno più forniti con i binari. Tutte le funzionalità precedenti dei binari saranno incluse in @axe-devtools/cli come sottocomandi. Per axe DevTools 4.0, Attest-standards sarà deprecato e non verrà rilasciato nella versione 4.0.