Migrando para Axe DevTools for Web v4.x para 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

Passos para a migração para a versão 4.x do Axe DevTools for Web para Node.js

Not for use with personal data

Axe DevTools NPM v4.x é uma reescrita significativa de todo o projeto. As mudanças mais notáveis estão resumidas abaixo, seguidas de alterações mais específicas para pacotes relevantes.

Resumo

A suíte axe-devtools-* de pacotes npm envolveu uma perspectiva de rebranding, bem como a unificação de ferramentas de integração para serem mais específicas à experiência do desenvolvedor.

Com isso em mente, todos os pacotes foram rebatizados para utilizar o namespace axe devtools e os binários foram combinados em um único pacote binário.

Atenção às mudanças que quebram compatibilidade

Dado o rebranding da API, é justo afirmar que a migração para o v4.0 envolve seguir este guia de migração passo a passo.

Configuração do Ambiente

Não há alterações nos requisitos padrão. Os requisitos desejados são os seguintes:

Versão LTS Node
NPM para dependências npm

Instalando Pacotes NPM do Axe DevTools

Certifique-se de ter acesso a Deque's registry. Se não tiver, consulte as informações de instalação para seu pacote:

Você pode instalar qualquer um dos pacotes npm abaixo ao incluí-los no arquivo package.json.

npm install @axe-devtools/browser

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

Os pacotes npm disponíveis são:

Por favor, consulte cada um dos pacotes npm acima para instruções de uso e documentação detalhada da API.

Opcionalmente, pode-se desinstalar as integrações de node anteriores (para pacotes com escopo ou sem escopo) executando os comandos abaixo:

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

Alterações Notáveis

Além das mudanças na instalação e uso com as gemas descritas, algumas alterações notáveis incluem:

A variável de ambiente para configurar regras personalizadas foi alterada de ATTEST_PATH para AXE_RULESET_PATH.
O conjunto de regras padrão foi alterado. Axe DevTools audita uma página dada com wcag2 como o conjunto de regras padrão. Nenhuma alteração é necessária por parte do usuário final. Se alguém desejar configurar um conjunto de regras diferente, pode usar @axe-devtools/cli para gerar um conjunto de regras diferente ou criar um arquivo axe-ruleset.json com seus conjuntos de regras desejados.
Todos os pacotes utilizarão axe-core v4.0.X.
Axe DevTools WebdriverIO não suportará mais o WebdriverIO v4 e agora suportará apenas o WebdriverIO v5 e v6.

Alterações nos binários

Attest-standards e Attest Reporter não serão mais enviados com binários. Toda a funcionalidade anterior dos binários será incluída em @axe-devtools/cli como subcomandos. Para Axe DevTools 4.0, Attest-standards será descontinuado e não terá uma versão 4.0.