レポート生成

Axe DevTools APIまたは axe CLIを使用してアクセシビリティをテストすると、結果はJSONファイルとして保存されます。 axe reporter コマンドを使用して、それらのJSONファイルをHTML、JUnit XML、CSV、またはユニバーサルフォーマットレポートに変換します。レポートの生成前にタイプ別に結果をフィルタリングすることもできます。

• アクションでタイトルが提供されている場合、またはページに axe reporter コマンド
• オプション
• ディスク上のJSON結果

アクションでタイトルが提供されている場合、またはページに axe reporter コマンド

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

アクションでタイトルが提供されている場合、またはページに <results-dir> は、JSON結果ファイルを含むディレクトリです。オプションの [dest-dir] は、レポートが書き込まれる場所です; また、 --dest を使って指定することもできます。

JSON結果からCSVレポートを生成します：

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

複数のフォーマットでレポートを同時に生成します：

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

オプション

-d, --dest <path>

生成されたレポートの出力ディレクトリを指定します。また、宛先を第2の位置引数として指定することもできます。

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

出力フォーマット： html、 junit （XML）、 csv、または universal。一度に複数のフォーマットを生成するには、カンマ、スペース、セミコロン、またはプラス記号で区切って指定します。区切り記号の周囲のスペースは無視されます。

アクションでタイトルが提供されている場合、またはページに universal 値は Axe ユニバーサルフォーマットでJSONファイルを出力し、これはAxe製品全体で共有される標準スキーマです。以下のオプションを使用して、出力にどのメタデータを記録するかを制御してください。

--universal-ruleset <id>

ユニバーサルフォーマット出力のメタデータに記録するルールセットIDを指定します。デフォルトは wcag2.1です。 ルールセット表 を参照してください。

--universal-best-practices

を記録します bestPracticesEnabled=true ユニバーサルフォーマット出力のメタデータに。

--filter <type(s)>

レポートに含まれる結果の種類をフィルタリングします。次のいずれかまたは複数を受け付けます： passes、 violations、 incomplete、 inapplicable。複数の値を区切るには、スペースなしでカンマを使用します。 --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>

結果ディレクトリに複数のブラウザからの結果が含まれている場合、このオプションを使用して1つのブラウザの結果のみからレポートを生成します。名前はテストを実行したときに使用したブラウザと一致する必要があります。例えば、 chrome または firefoxなどです。

ディスク上のJSON結果

Axe DevTools CLIがJSON結果ファイルをどのように命名し、整理するかを理解することは、 axe reporter コマンドを使用する際や、プログラム上で結果を処理する際に役立ちます。

ディレクトリ構造

仕様ファイル内の各プロジェクトについて、結果はプロジェクトの id名のサブディレクトリ内に保存されます。このサブディレクトリは指定された出力ディレクトリ内にあります：

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

このサブディレクトリは自動的に作成されます。既に前回の実行から存在する場合は、 <project-id>-<timestamp> に名前を変更してアーカイブされ、新しいディレクトリが作成されます。

ファイル命名

各JSON結果ファイルは、プロジェクト名とページの id から派生したページ状態で命名されています。 id およびオプションの title がアクションから analyze 付加されます。

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

ページIDは id フィールドから取得されます。 id もし pageListがページに明示的に設定されていない場合、ページ名から自動的に派生されます id 。スペースを除去して派生されます。 name セグメントは、

アクションでタイトルが提供されている場合、またはページに analyze-title 複数の呼び出しがある場合にのみ追加されます（この場合、各結果に一意の接尾辞が付与され、衝突を回避します）。 analyze 例 analyze プロジェクトに

があり、ページに

（明示的な id: "deque" がない）場合、自動派生されたページIDは name: "Deque search" となります。 idタイトルのない単一の呼び出しによって生成されるのは： Dequesearchを使用して analyze ：

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

次の analyze the page with title "initial state"：

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