レポート生成

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

• 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を記録します。

HTMLレポート

HTMLレポートは、開くと自動的にレンダリングされます。ファイルを書き込む前に、CLIはそれを静的マークアップに事前レンダリングしようとします。そのため、開いたときにすぐにコンテンツが表示され、遅れて表示されることはありません。このステップは、テストに使用したブラウザーとは無関係であり、--chrome-pathや--chrome-optionsのようなオプションはここでは適用されません。

CLIをNode.jsパッケージとしてインストールした場合、事前レンダリングは自動的に動作し、ブラウザーは必要ありません。スタンドアロン実行ファイルを使用している場合、CLIは代わりに、このステップに使用できるインストール済みのChrome、Edge、またはBraveを探します。特定のブラウザーを指し示すには、AXE_DEVTOOLS_REPORTER_BROWSER_PATH環境変数を設定します。

（スタンドアロン実行ファイルを使用しているときに）CLIがブラウザーを見つけられない場合、警告を表示してレポートを書き込みます。開いたときにレポートは通常通り表示され、機能しますが、その瞬時表示の最適化は行われません。

遅いビルドマシンや大きなレポートの場合、HTMLレポートの生成がbrowser render timed out after 30000msのようなエラーで失敗することがあります。より多くの時間を許可するには、AXE_DEVTOOLS_REPORTER_RENDER_TIMEOUT_MSをミリ秒単位の数値に設定します。デフォルトは30000（30秒）です。値は通常の数字で書きます。他の値は無視され、デフォルトが使用されます。

export AXE_DEVTOOLS_REPORTER_RENDER_TIMEOUT_MS=120000

HTMLレポートの生成方法を制御するその他の環境変数については、HTMLレポートの事前レンダリングを参照してください。

--filter <type(s)>

レポートに含める結果タイプをフィルタリングします。passes, violations, incomplete, inapplicableの1つまたは複数を受け付けます。複数の値はスペースを入れずにカンマで区切ります。--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とanalyzeアクションからのオプションのtitleに由来するページ状態を使用して命名されます。

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

ページidはidのpageListフィールドから取得されます。ページにidが明示されていない場合は、ページnameからスペースを除去して自動的に取得されます。

analyze-titleセグメントはanalyzeアクションでタイトルが提供されたとき、またはページに複数のanalyzeコールがあるとき（この場合、結果が重複しないように固有のサフィックスがそれぞれに付加されます）にのみ追加されます。

があり、ページに

プロジェクトにid: "deque"があり、ページにname: "Deque search"がある（明示的なidはない）とすると、自動的に導出されたページIDはDequesearchです。タイトルのない単一のanalyzeコールは以下のように生成されます。

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

analyze the page with title "initial state"の場合:

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