axe DevTools Reporter CLI
Genere informes independientes desde axe DevTools Mobile para compartir con su equipo, ya sea usuario con licencia o no.
La interfaz de línea de comandos (CLI) de axe DevTools Reporter ha tomado la potencia de generación de informes disponible en axe DevTools CLI y la ha convertido en una herramienta de generación de informes liviana e independiente.
La CLI de axe DevTools Reporter requiere archivos JSON de axe DevTools Mobile para crear un informe. Los archivos JSON se pueden obtener de dos fuentes:
- Recomendado para uso personal: Exportación de escaneos desde el panel de control de axe DevTools Mobile
- Recomendado para la canalización CI/CD: guardar los resultados localmente dentro de su ejecución de prueba automatizada
¿Ya tienes instalado el Reporter CLI? Consulte nuestra siguiente guía sobre Generar informes con CI/CD.
¿Ya utiliza la CLI de DevTools de axe?
La CLI de axe DevTools admite la generación de informes HTML a partir de escaneos de axe DevTools Mobile. Proporcione a la CLI un directorio que contenga sus escaneos móviles como archivos JSON.
Nota: Para obtener más información sobre la herramienta, consulte la documentación de axe DevTools CLI.
Configuración por primera vez
Descargar a través de npm
La CLI de axe DevTools Reporter está disponible a través de Deque's Artifactory como un paquete npm. Siga nuestra guía para configurar su registro npm para acceder a axe DevTools Mobile.
Descarga directa
Encuentre su sistema operativo en las subsecciones siguientes. Una vez que se haya descargado la CLI de axe DevTools Reporter de Deque's Artifactory, abra la línea de comando y navegue hasta la ubicación del ejecutable. Utilice el comando debajo del enlace de descarga para probar la instalación.
Modo administrador
Dependiendo de la configuración de su máquina, es posible que necesite utilizar el modo administrador.
Habilitar instalación global
Hacer que la CLI de axe DevTools Reporter esté disponible globalmente desde cualquier directorio colocándolo en un directorio en el $PATH de su sistema. Puede ver qué directorios están en el $PATH de su sistema ejecutando `echo $PATH`.
Su descarga debe ser un ejecutable, es posible que necesite ejecutar chmod +x <name> en la terminal para que funcione en máquinas Mac o Linux.
En Windows
Pruebe la instalación con:
./reporter-cli-win.exe --helpEn Linux
Pruebe la instalación con:
./reporter-cli-linux --helpEn macOS
Pruebe la instalación con:
./reporter-cli-macos --helpGenerando informes
Una vez que haya reunido los escaneos de axe DevTools Mobile como archivos JSON, estará listo para crear un informe. Asegúrese de que todos los escaneos estén en un directorio y luego ejecute el siguiente comando para generar los informes HTML:
axe-devtools-reporter <devtools-results-directory> <output-directory> --format=htmlEl directorio de salida es opcional y, si no se proporciona, los informes se almacenarán en el mismo ./axe-devtools-reporter.
Los nombres de archivo se derivan del nombre del escaneo y de la marca de tiempo del análisis del escaneo. ${scanName}-axe-result-${timestamp}.html
Asegúrese de consultar executive-report.html para ver los resultados combinados de todos los análisis dentro del paquete.
Formato de salida
Además del informe HTML, también puede exportar los datos en formato CSV o XML/JUnit.
HTML:
axe-devtools-reporter <devtools-results-directory> <output-directory> --format=htmlXML/JUnit:
axe-devtools-reporter <devtools-results-directory> <output-directory> --format=junitCSV:
axe-devtools-reporter <devtools-results-directory> <output-directory> --format=csv