Axe DevTools para CLI Web
Una herramienta de línea de comandos para automatizar pruebas de accesibilidad web sin escribir código de prueba.
Axe DevTools para Web CLI es una herramienta de línea de comandos que realiza análisis de accesibilidad en páginas web y genera informes. Está diseñado para equipos que desean automatizar las pruebas de accesibilidad sin integrar Axe DevTools en un marco de pruebas existente, por ejemplo, como un paso en una pipeline de CI/CD, o cuando las API de Axe DevTools no están disponibles para tu idioma.
Cómo Funciona
Cada axe análisis produce archivos de resultados JSON, uno por cada estado de página analizado. Estos archivos se generan durante las pruebas y se consumen al informar o cargar los resultados.
El flujo de trabajo típico tiene dos fases:
-
Analizar páginas: ejecuta una o más URL a través de
axey guarda los resultados en JSON:axe <url> → test a URL directly axe spec <spec-file> → test pages and workflows defined in a YAML/JSON file axe bulk-spec <dir> → test using all spec files in a directory -
Hacer algo con los resultados: convierte, carga o envía los resultados a otro lugar:
axe reporter <results> → generate HTML, JUnit XML, or CSV reports axe bulk-reports <results> → upload to the Axe Reports service axe devhub <results> → send to Axe Developer Hub
Los comandos axe y axe spec también admiten las banderas --format y --report para generar informes en un solo paso, sin necesidad de una invocación axe reporter por separado.
Elementos personalizados y ElementInternals
A partir de la versión 4.13.0, los análisis leen la semántica ARIA que los componentes web declaran en JavaScript a través de ElementInternals, en lugar de solo los atributos role y aria-* presentes en el marcado. No se requiere configuración ni opción de línea de comandos. Sus componentes deben publicar sus elementos internos para que esto surta efecto, y no se puede leer un componente que los almacena en un campo de clase privada. Vea Pruebas de elementos personalizados que usan ElementInternals.
Comandos
| Comando | Propósito |
|---|---|
axe <url...> |
Analizar una o más URLs directamente. Navegador predeterminado: Firefox. Conjunto de reglas predeterminado: WCAG 2.1 AA. |
axe spec <spec-file> |
Analizar páginas definidas en un archivo de especificación YAML o JSON, incluidos flujos de trabajo de varios pasos. |
axe bulk-spec <dir> |
Ejecutar todos los archivos de especificación encontrados en un directorio y sus subdirectorios. |
axe reporter <results-dir> |
Convertir resultados JSON a informes HTML, JUnit XML o CSV. |
axe bulk-reports <results-dir> |
Subir resultados JSON al servicio de informes de Axe. |
axe devhub <results-dir> |
Enviar resultados JSON al Centro de Desarrolladores de Axe. |
axe ruleset |
Listar, validar o gestionar conjuntos de reglas personalizados. |
axe config-selenium |
Ver o actualizar los ajustes predeterminados del navegador/Selenium. |
Resultados JSON
Cuando ejecutas axe spec o usas axe <url> --save, los resultados se escriben como archivos JSON en el directorio de salida. Cada archivo captura el análisis completo de axe para un solo estado de página: violaciones, aprobaciones, comprobaciones incompletas y reglas no aplicables, junto con metadatos como la URL, el navegador y la marca de tiempo.
Los archivos de resultados se organizan por proyecto y se nombran según la página que se está probando:
<output-dir>/<project-id>/<project-id>-<page-id>[-<analyze-title>].jsonEstos archivos son utilizados por axe reporter, axe bulk-reports y axe devhub. Para más detalles sobre el nombre de los archivos y la estructura de directorios, consulta Generar Informes.
El esquema de resultados en JSON está definido por axe-core. Para una referencia completa, consulta el documentación de la API de axe-core.
En Esta Sección
- Comenzar: tareas comunes con ejemplos prácticos
- Instalar: opciones de instalación (ejecutable o paquete de Node.js)
- Analizar Páginas: todas las opciones para
axe <url> - Analizar Páginas Usando un Archivo Específico: estructura del archivo de especificaciones, acciones y procesamiento por lotes
- Análisis de iframes: cobertura de marcos, resultados de marcos, y elementos de destino dentro de un marco
- Generar Informes: formatos de informe, filtrado y estructura de resultados en JSON
- Enviar a Axe Reports: cargar resultados al servicio Axe Reports
- Enviar al Centro de Desarrolladores de Axe: integrar resultados con Axe Developer Hub
- Configurar: selección de navegador, tiempos de espera y configuraciones persistentes
- Conjuntos de Reglas Personalizados: WCAG 2.x, Sección 508 y conjuntos de reglas personalizados
