Axe DevTools for Web CLI

Axe DevTools for Web CLIは、ウェブページのアクセシビリティ分析を実行し、レポートを生成するコマンドラインツールです。これは、既存のテストフレームワークにaxeを統合せずにアクセシビリティテストを自動化したいチーム向けに設計されています。たとえば、CI/CDパイプラインのステップとしてや、使用言語でAxe DevTools APIが利用できない場合などに適しています。

仕組み

すべての axe 分析は JSON結果ファイルを生成します。各分析されたページ状態につき1つのファイルが作成されます。これらのファイルはテスト中に生成され、レポート作成や結果のアップロード時に使用されます。

一般的なワークフローは2つのフェーズがあります：

1. ページの分析：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

2. 結果に対する操作：変換、アップロード、または他所に送信する：

   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

コマンド

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>
• 仕様ファイルを使用してページを分析：仕様ファイルの構造、アクション、およびバッチ処理
• レポートの生成：レポート形式、フィルタリング、JSON結果の構造
• Axe Reportsに送信：Axe Reportsサービスに結果をアップロード
• Axe Developer Hubに送信：Axe Developer Hubと結果を統合
• 設定：ブラウザの選択、タイムアウト、永続設定
• カスタムルールセット：WCAG 2.x、Section 508、およびカスタムルールセット