Générer des rapports

Lorsque vous utilisez les APIs d'Axe DevTools ou le axe CLI pour tester l'accessibilité, les résultats sont enregistrés sous forme de fichiers JSON. Utilisez la commande axe reporter commande 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.

• Le segment axe reporter Command
• 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

Le segment axe reporter Command

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

Le segment <results-dir> est l'endroit où les rapports sont écrits; vous pouvez également utiliser [dest-dir] pour spécifier cela. --dest Si vous utilisez le

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)>

, html. Séparez les valeurs multiples par des virgules sans espaces. Nécessite junit (XML), csv, ou universalFiltre les types de résultats à inclure dans le rapport. Accepte un ou plusieurs de :

Le segment universal la valeur génère un fichier JSON dans le format universel Axe, qui est un schéma standard partagé entre les produits Axe. Utilisez les options complémentaires ci-dessous pour contrôler quelles métadonnées sont 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, wcag2.1. Voir la 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)>

, passes. Séparez les valeurs multiples par des virgules sans espaces. Nécessite violations. Séparez les valeurs multiples par des virgules sans espaces. Nécessite incomplete. Séparez les valeurs multiples par des virgules sans espaces. Nécessite inapplicable. --format csvRésultats JSON sur disque

# 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>

ou chrome . firefoxRésultats JSON sur disque

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

ou pour traiter les résultats de manière programmée. axe reporter Structure du répertoire

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

projet, à l'intérieur du répertoire de sortie que vous spécifiez : idCe sous-répertoire est créé automatiquement. S'il existe déjà à partir d'une exécution précédente, il est archivé en étant renommé

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

avant qu'un nouveau répertoire soit créé. <project-id>-<timestamp> Nommage des fichiers

Nomination des fichiers

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

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

La page id provient du champ id dans pageList. Si id n'est pas explicitement défini sur une page, il est dérivé automatiquement de la page name 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 de analyze (dans ce cas, chaque résultat obtient un suffixe unique pour éviter les collisions).

Exemple

Étant donné un projet avec id: "deque" et une page avec name: "Deque search" (pas de idexplicite), l'ID de page dérivé automatiquement est Dequesearch. Un seul appel de 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