Axe DevTools for Web CLI
テストコードを書くことなく、Webアクセシビリティテストを自動化するためのコマンドラインツール。
Axe DevTools for Web CLIは、Webページのアクセシビリティ分析を実行し、レポートを生成するコマンドラインツールです。既存のテストフレームワークにAxe DevToolsを統合せずにアクセシビリティテストを自動化したいチーム向けに設計されています。例えば、CI/CDパイプラインのステップとして、またはAxe DevTools APIが使用している言語で利用できない場合に役立ちます。
仕組み
すべてのaxe分析は、解析されたページ状態ごとにJSON結果ファイルを生成します。これらのファイルはテスト時に生成され、レポートや結果のアップロード時に使用されます。
一般的なワークフローは2つのフェーズがあります：
-
ページの分析: 1つ以上のURLを
axeを介して実行し、JSON結果を保存します:axe <url> → test a URL directly axe spec <spec-file> → test pages and workflows defined in a YAML/JSON file axe bulk-spec <dir> → test using all spec files in a directory -
結果に対する操作: 変換、アップロード、または別の場所への送信:
axe reporter <results> → generate HTML, JUnit XML, or CSV reports axe bulk-reports <results> → upload to the Axe Reports service axe devhub <results> → send to Axe Developer Hub
axeおよびaxe specコマンドは、--formatおよび--reportフラグをサポートしており、axe reporterを別途実行しなくても、一度にレポートを生成できます。
カスタム要素とElementInternals
バージョン4.13.0から、スキャンはElementInternalsを介してJavaScriptで宣言されたウェブコンポーネントのARIAセマンティクスを読み取るようになり、マークアップに存在するroleおよびaria-*属性のみを対象とするのではなくなりました。これに設定やコマンドラインオプションは不要です。この効果を得るには、コンポーネントがその内部構造を公開しておく必要があり、プライベートクラスフィールドに保存されているコンポーネントは読み取ることができません。ElementInternalsを使用するカスタム要素のテストを参照してください。
コマンド
| コマンド | 目的 |
|---|---|
axe <url...> |
1つまたは複数のURLを直接分析します。デフォルトのブラウザ：Firefox。デフォルトのルールセット：WCAG 2.1 AA。 |
axe spec <spec-file> |
YAMLまたはJSON仕様ファイルで定義されたページを、多段階のワークフローを含めて分析します。 |
axe bulk-spec <dir> |
ディレクトリおよびそのサブディレクトリに見つかるすべての仕様ファイルを実行します。 |
axe reporter <results-dir> |
JSON結果をHTML、JUnit XML、またはCSVレポートに変換します。 |
axe bulk-reports <results-dir> |
JSON結果をAxe Reportsサービスにアップロードします。 |
axe devhub <results-dir> |
JSON結果をAxe Developer Hubに送信します。 |
axe ruleset |
カスタムルールセットを一覧表示、検証、または管理します。 |
axe config-selenium |
デフォルトのブラウザ/Selenium設定を表示または更新します。 |
JSON結果
axe specを実行するかaxe <url> --saveを使用することで、結果は出力ディレクトリにJSONファイルとして書き込まれます。各ファイルは、単一ページ状態の完全なaxe分析をキャプチャします: 違反、合格、不完全なチェック、および適用不能なルール、さらにURL、ブラウザ、タイムスタンプなどのメタデータを含みます。
結果ファイルはプロジェクトごとに整理され、テストされるページの名前で命名されます：
<output-dir>/<project-id>/<project-id>-<page-id>[-<analyze-title>].jsonこれらのファイルはaxe reporter、axe bulk-reports、axe devhubによって使用されます。ファイル命名およびディレクトリ構造の詳細については、レポートの生成を参照してください。
JSON結果のスキーマはaxe-coreによって定義されています。完全なリファレンスについては、axe-core APIドキュメントを参照してください。
このセクション内
- 始め方: 実例を伴う一般的なタスク
- インストール: インストールオプション（実行可能ファイルまたはNode.jsパッケージ）
- ページを分析:
axe <url>のすべてのオプション - 仕様ファイルを使用してページを分析: 仕様ファイル構造、アクション、バッチ処理
- iframeの分析：フレームカバレッジ、フレーム結果、およびフレーム内の要素のターゲット設定
- レポートの生成: レポート形式、フィルタリング、およびJSON結果構造
- Axe Reportsに送信: Axeレポートサービスへの結果アップロード
- Axe Developer Hubに送信: Axe Developer Hubとの結果統合
- 設定: ブラウザの選択、タイムアウト、および永続的な設定
- カスタムルールセット: WCAG 2.x、セクション508およびカスタムルールセット