Générer des rapports

Lorsque vous utilisez les API Axe DevTools ou le CLI axe pour tester l'accessibilité, les résultats sont enregistrés sous forme de fichiers JSON. Utilisez la commande axe reporter pour convertir ces fichiers JSON en rapports au format HTML, JUnit XML, CSV ou universel. Vous pouvez également filtrer les résultats par type avant de générer un rapport.

• La commande axe reporter
• Spécifie le répertoire de sortie pour les rapports générés. Vous pouvez également spécifier la destination comme deuxième argument positionnel.
• Comprendre comment le CLI Axe DevTools nomme et organise les fichiers de résultats JSON est utile lors de l'utilisation de la commande

La commande axe reporter

axe reporter <results-dir> [dest-dir] [options]

Le <results-dir> est le répertoire contenant les fichiers de résultats JSON. Le [dest-dir] optionnel est le lieu où les rapports sont écrits ; vous pouvez aussi utiliser --dest pour le spécifier.

Générer des rapports dans plusieurs formats à la fois :

axe reporter ./axe-results/ ./axe-reports/csv/ --format=csv

Options

axe reporter ./axe-results/ ./axe-reports/ --format=csv,html,junit

Spécifie le répertoire de sortie pour les rapports générés. Vous pouvez également spécifier la destination comme deuxième argument positionnel.

-d, --dest <path>

Format(s) de sortie :

-f, --format <type(s)>

Format(s) de sortie : html, junit (XML), csv, ou universal. Pour générer plusieurs formats en une seule exécution, fournissez-les séparés par des virgules, des espaces, des points-virgules ou des signes plus. L'espacement autour des séparateurs est ignoré.

La valeur universal produit un fichier JSON dans la format universel Axe, qui est un schéma standard partagé par les produits Axe. Utilisez les options complémentaires ci-dessous pour contrôler les métadonnées enregistrées dans la sortie.

--universal-ruleset <id>

Spécifie l'ID du jeu de règles à enregistrer dans les métadonnées de la sortie au format universel. Par défaut, il est à wcag2.1. Voir le table des jeux de règles pour les valeurs valides.

--universal-best-practices

Enregistre bestPracticesEnabled=true dans les métadonnées de la sortie au format universel.

--filter <type(s)>

Filtre les types de résultats à inclure dans le rapport. Accepte un ou plusieurs des types suivants : passes, violations, incomplete, inapplicable. Séparez les valeurs multiples par des virgules sans espaces. Nécessite --format csv.

# Include only violations and incomplete results
axe reporter ./axe-results/ --format=csv --filter violations,incomplete

# Include only passed checks
axe reporter ./axe-results/ --format=csv --filter passes

-b, --browser <name>

Lorsqu'un répertoire de résultats contient des résultats de plusieurs navigateurs, utilisez cette option pour générer un rapport uniquement des résultats d'un navigateur. Le nom doit correspondre au navigateur utilisé pour réaliser les tests, par exemple, chrome ou firefox.

Comprendre comment le CLI Axe DevTools nomme et organise les fichiers de résultats JSON est utile lors de l'utilisation de la commande

Comprendre comment le CLI Axe DevTools nomme et organise les fichiers de résultats JSON est utile lors de l'utilisation de la commande axe reporter ou du traitement des résultats de manière programmatique.

Pour chaque projet dans un fichier spec, les résultats sont enregistrés dans un sous-répertoire portant le nom du

Pour chaque projet dans un fichier de spécifications, les résultats sont enregistrés dans un sous-répertoire nommé d'après le id du projet, à l'intérieur du répertoire de sortie que vous spécifiez :

<output-dir>/<project-id>/

Ce sous-répertoire est créé automatiquement. S'il existe déjà à partir d'une exécution précédente, il est archivé en le renommant en <project-id>-<timestamp> avant qu'un nouveau répertoire ne soit créé.

Nomination des fichiers

Chaque fichier de résultats JSON est nommé en utilisant le id du projet et un état de page dérivé de la id de la page et de l'optionnel title de l'action analyze :

<project-id>-<page-id>[-<analyze-title>].json

La id de la page provient du champ id dans pageList. Si id n'est pas explicitement défini sur une page, il est dérivé automatiquement de la name de la page en supprimant les espaces.

Le segment analyze-title est ajouté uniquement lorsqu'un titre est fourni dans l'action analyze, ou lorsqu'une page a plusieurs appels analyze (dans ce cas, chaque résultat reçoit un suffixe unique pour éviter les collisions).

Exemple

Pour un projet avec id: "deque" et une page avec name: "Deque search" (sans id explicite), l'ID de page dérivé automatiquement est Dequesearch. Un seul appel analyze sans titre produit :

<output-dir>/deque/deque-Dequesearch.json

Avec analyze the page with title "initial state" :

<output-dir>/deque/deque-Dequesearch-initial state.json