Migración a axe DevTools for Web v4.x para Node.js
Pasos para migrar a la versión 4.x de axe DevTools for Web para Node.js
Axe DevTools NPM v4.x es una reescritura importante de todo el proyecto. A continuación se resumen los cambios más notables, seguidos de cambios más específicos en los paquetes relevantes.
Resumen
La suite de paquetes npm axe-devtools-*
implicó un cambio de marca, así como la unificación de las herramientas de integración para ser más específicas a la experiencia del desarrollador.
Con esto en mente, todos los paquetes han sido renombrados para utilizar el axe devtools
espacio de nombres y los binarios se han combinado en un solo paquete binario.
Tenga cuidado con los cambios incompatibles
Dado el cambio de marca de la API, es justo destacar que la migración a la versión 4.0 implica seguir esta guía de migración paso a paso.
Configuración del entorno
No hay cambios con los requisitos predeterminados. Los requisitos deseados son los siguientes:
Instalación de paquetes NPM de axe DevTools
Asegúrese de tener acceso al [registro de Deque][]. En caso contrario, consulte la información de instalación de su paquete:
Puede instalar cualquiera de los siguientes paquetes npm incluyéndolos en el archivo package.json.
npm install @axe-devtools/browser
// package.json
{
"@axe-devtools/browser": "^4.0.0"
}
Los paquetes npm disponibles son:
- CLI de Axe DevTools
- Axe DevTools Puppeteer
- [Axe DevTools Reporter][]
- Axe DevTools WebdriverIO []
- Axe DevTools WebDriverJS []
Consulte cada uno de los paquetes npm anteriores para obtener instrucciones de uso y documentación detallada de la API.
Opcionalmente, se pueden desinstalar las integraciones de Node anteriores (para paquetes con alcance o sin alcance) ejecutando los siguientes comandos:
npm uninstall attest-js
npm uninstall @deque/attest-js
Cambios notables
Además de los cambios en la instalación y el uso de las gemas descritas, algunos cambios dignos de mención incluyen:
- La variable de entorno para configurar reglas personalizadas se ha cambiado de
ATTEST_PATH
aAXE_RULESET_PATH
. - El conjunto de reglas predeterminado ha cambiado. Axe DevTools audita una página determinada con
wcag2
como conjunto de reglas predeterminado. No se requiere ningún cambio por parte del usuario final. Si uno desea configurar un conjunto de reglas diferente, puede usar@axe-devtools/cli
para generar un conjunto de reglas diferente o crear un archivo axe-ruleset.json con los conjuntos de reglas deseados. - Todos los paquetes utilizarán axe-core v4.0.X.
- Axe DevTools WebdriverIO ya no soportará WebdriverIO v4 y ahora solo soportará WebdriverIO v5 y v6.
Cambios en los binarios
Attest-standards y Attest Reporter ya no se enviarán con binarios. Toda la funcionalidad anterior de los binarios se incluirá en @axe-devtools/cli como subcomandos. Para axe DevTools 4.0, Attest-standards quedará obsoleto y no tendrá una versión 4.0.