Axe DevTools for Web CLIの設定

この記事で説明されているフラグは axe <url>、 axe spec、および axe bulk-specで利用可能です。これらのフラグのいずれかを設定すると、その値は 設定ファイル に保存され、以降のすべての実行でデフォルトとなります。フラグがない値をリセットすることを含め、設定をインタラクティブに表示または変更するには axe config-seleniumを使用してください。

ブラウザオプション

--accept-untrusted

ブラウザに信頼されていないSSL証明書を受け入れるよう指示します。これは、自己署名証明書を使用するローカル開発サーバーや内部環境でページをテストする際に使用してください。このフラグを渡すと、 acceptUntrustedCertificates: true が 設定ファイルに保存されます。それをリセットするには falseを実行し、 axe config-selenium 「 いいえ 」を選択するか、設定ファイルを直接編集してください。

axe <url> --accept-untrusted

--browser <name>

使用するブラウザを指定します。対応するWebDriverがインストールされており、あなたの $PATHで利用可能でなければなりません。有効な値は次のとおりです： firefox （デフォルト）、 chrome、 safari、 edge、 ie。

axe <url> --browser chrome

初回の実行時にブラウザの起動エラーが発生した場合、GeckoDriver（FirefoxのWebDriver）がインストールされていない可能性があります。代わりに --browser chrome を試してください。これは通常、ほとんどのシステムで追加のセットアップなしに動作します。

このフラグを渡すと、ブラウザ名が 設定ファイルに保存されます。以降のすべての実行では、 --browserを使わない実行も含め、保存されたブラウザが使用されます。保存されたブラウザを変更するには axe config-selenium を実行し、プロンプトで別のブラウザを選択するか、 設定ファイル を直接編集してください。

--headless

ブラウザをヘッドレスモード（ウィンドウを表示しない）で起動します。デフォルトは falseです。

axe <url> --headless

--remote-server <url>

ローカルブラウザを起動する代わりに、リモートWebDriverサーバーに接続します。サーバーはSelenium Grid、BrowserStack、Sauce Labsのリモートなど、W3C WebDriver準拠のエンドポイントを公開している必要があります。

axe <url> --remote-server https://hub.browserstack.com/wd/hub

--window-size <width,height>

ブラウザのウィンドウサイズをピクセルで設定します。これはヘッドレスモードでのビューポートサイズも制御し、レスポンシブレイアウトのテストに便利です。

axe <url> --window-size 1280,900

タイミングオプション

--page-timeout <ms>

ページの読み込みが完了するのを待つ最大時間をミリ秒（ms）で指定します。デフォルトは60,000 ms（60秒）です。読み込みの遅いページや高レイテンシのネットワーク環境ではこれを増やしてください。

axe <url> --page-timeout 120000

--post-analyze-pause <ms>

分析完了後、次の操作までにワークフローを一旦停止させる時間をミリ秒で指定します。デフォルトは2,000 ms（2秒）です。

axe spec workflow.yml --post-analyze-pause 5000

--post-get-pause <ms>

ページの読み込み後、スキャンを開始する前に一旦停止させる時間をミリ秒で指定します。デフォルトは2,000 ms（2秒）です。動的コンテンツがスキャンを始める前にレンダリングされるためにより多くの時間を必要とする場合はこれを増やしてください。

axe <url> --post-get-pause 5000

--post-script-pause <ms>

ワークフロースクリプトの操作を実行した後、次の操作を続行する前に一旦停止させる時間をミリ秒で指定します。デフォルトは2,000 ms（2秒）です。

axe spec workflow.yml --post-script-pause 5000

--script-timeout <ms>

ワークフロースクリプトの実行完了を待つ最大時間をミリ秒で指定します。デフォルトは60,000 ms（60秒）です。

axe spec workflow.yml --script-timeout 120000

使用状況トラッキング

Axe DevTools CLIには @deque/metrics-libraryが含まれており、匿名の使用状況データをDequeに送信します。このデータには違反件数、ルール件数、axe-coreエンジンバージョンなどの集計情報が含まれていますが、URLやページコンテンツ、個人を特定できる情報は含まれていません。

独自の 識別ID は、ユーザーを特定せずに複数のCLI実行間でイベントを関連付けるために使用される値で、設定ファイルに保存されます。下記のオプションで追跡を変更または無効にできます。CLIを使用せずに追跡を完全に無効にするには、環境変数 AXE_TRACK_USAGE=false。

--enable-tracking <state>

使用データをメトリクスライブラリに送信するかどうかを有効または無効にします。「 true 」を渡して有効にするか、「 false 」を渡して無効にします。

axe <url> --enable-tracking false

--set-distinct-id <id>

使用イベントを関連付けるために使用される固有IDを変更します。このIDは、設定ファイルに保存され、実行ごとに使用されます。

axe <url> --set-distinct-id my-team-id

--set-tracking-url <url>

使用メトリクスが送信されるエンドポイントを変更します。組織が内部プロキシを通じてテレメトリをルーティングする場合に使用します。

axe <url> --set-tracking-url https://metrics.example.com/collect

axe config-selenium

「 axe config-selenium 」を使用してインタラクティブにデフォルトを設定します。ブラウザ、タイムアウト、その他の設定の値を入力するように求められます。あなたの回答は設定ファイルに保存され、その後のすべてのCLI実行のデフォルトになります。

$ axe config-selenium
? Choose browser for running automated tests: (Use arrow keys)
? Choose browser for running automated tests: chrome
? Enter a value for pageLoadTimeout: 60000
? Enter a value for setScriptTimeout: 60000
? Accept untrusted ssl certs: Yes
? Enter a value for postGetPause: 2000
? Enter a value for postScriptPause: 2000
? Enter a value for postAnalysisPause: 2000
? Launch browser in headless mode: No

Results saved to ~/.config/preferences/com.deque.axe.devtools.cli.pref

インタラクティブなプロンプトに入ることなく現在保存されている設定を表示するには、「 --show 」を使用します。

axe config-selenium --show

設定ファイル

すべての設定可能なデフォルトは、以下のJSONファイルに保存されます：

~/.config/preferences/com.deque.axe.devtools.cli.pref

典型的なファイルはこのようなものです：

{
  "selenium": {
    "acceptUntrustedCertificates": false,
    "browser": "firefox",
    "headless": false,
    "pageLoadTimeout": 60000,
    "postAnalysisPause": 2000,
    "postGetPause": 2000,
    "postScriptPause": 2000,
    "setScriptTimeout": 60000
  }
}

またはコマンドラインでフラグを渡す代わりに、このファイルを直接編集することができます。 axe config-selenium これは「 acceptUntrustedCertificates 」のような真偽値を設定するためにインタラクティブなプロンプトを実行せずにリセットするのに便利です。