インストール
JavaScript、TypeScript、またはJavaでAxe Watcherを使用した自動アクセシビリティテストのインストール
Axe Watcherは、アクセシビリティテストを既存のエンドツーエンドテストスイートに統合します。このガイドでは、パッケージのJavaScript/TypeScriptバージョンとJavaバージョンの両方のインストールを説明します。
システム要件
Axe Watcherをインストールする前に、環境が次の要件を満たしていることを確認してください:
-
言語サポート: テストはJavaScript、TypeScript、またはJavaで記述されている必要があります。
-
Node.js（JavaScript/TypeScriptのみ）：現在メンテナンスされているLong Term Support（LTS）バージョンのNode.jsを使用してください。
-
Java（Javaのみ）：現在メンテナンスされているLTSバージョンのJavaを使用してください。
-
ブラウザ自動化プラットフォームのバージョン: Axe Watcherは、各サポートプラットフォームの最新バージョンまたは以前のメジャーバージョンをサポートしています（ただし、PlaywrightおよびPlaywright Testでは、以前のマイナーバージョンバージョン以上をサポート）。
-
ブラウザ: Watcherは、テスト用の最新の安定版ChromeまたはChromiumを使用します（JavaScript/TypeScriptまたはJavaでPlaywrightを使用する場合、Microsoft Edgeも使用可能）。Cypressの組み込みElectronブラウザはWatcherと互換性がなく、Cypressを
cypress run --browser chrome-for-testing --headless、cypress run --browser chromium --headless、またはcypress run --browser edge --headlessで起動する必要があります。 -
npmレジストリアクセス（JavaScript/TypeScriptのみ）：環境ではnpmレジストリからパッケージをダウンロードおよびインストールする許可が必要です。
-
Maven Centralリポジトリアクセス（Javaのみ）：環境ではMaven Centralからパッケージをダウンロードおよびインストールする許可が必要です。
-
Gitリポジトリ（任意ですが推奨）：Gitを使用することで、アクセシビリティの結果と特定のコミットを関連付けたり、プロジェクトのアクセシビリティの進捗を長期にわたり監視したりできます。
古いプラットフォーム（Node.jsおよびJava）のサポートを終了することはではない破壊的な変更とみなされます。 これは依存関係のセキュリティ更新を許可するために非常に重要です。 移行を容易にするため、EOLプラットフォームのEOL日以降1か月間、サポートを続けます。 その後、サポートは終了し、EOLプラットフォーム上でパッケージが動作しなくなる可能性があります。
JavaScriptおよびTypeScriptのインストール
@axe-core/watcherパッケージはnpmにて利用可能です。お好みのパッケージマネージャーを使用してテストフォルダのルートレベルにインストールしてください:
npm install --save-dev @axe-core/watcherまたはyarnを使用して:
yarn add --dev @axe-core/watcherまたはpnpmを使用して:
pnpm add --save-dev @axe-core/watcherサポートされているプラットフォーム
JavaScript/TypeScriptパッケージは、次のブラウザ自動化プラットフォームをサポートします（現在のバージョンと1つ前のメジャーバージョン）：
- Cypress（コンポーネントテストを含む）
- Playwright（以前のマイナーバージョンと以降をサポート）
- Playwright Test（以前のマイナーバージョンと以降をサポート）
- Puppeteer
- WebdriverIO
- WebdriverIO Testrunner
- WebDriverJS（Selenium）
インストール後、Axe Watcherのドキュメント内にあるJavaScriptまたはTypeScriptフレームワーク固有の手順に従ってテストスイートを設定してください。
Javaのインストール
Java WatcherパッケージはMaven Centralで入手可能です。pom.xmlに依存関係を追加してください:
<dependencies>
<dependency>
<groupId>com.deque.axe_core</groupId>
<artifactId>watcher</artifactId>
<version>4.0.0</version>
</dependency>
</dependencies>最新リリースを使用するにはバージョン番号を必要に応じて更新してください。パッケージの利用可能なバージョンに関する詳細はMaven Centralで確認できます。
サポートされているプラットフォーム
JavaパッケージはSelenium WebDriverをサポートしています（現在のバージョンと1つ前のメジャーバージョン）。
次のステップ
パッケージがインストールされたら、次のことを行う必要があります:
- プロジェクト ID を取得するために、Axe Developer Hub でプロジェクトを作成してください
- 特定のテストフレームワーク用の指示に従ってテストスイートを修正してください
ACCESSIBILITY_API_KEYとPROJECT_IDを環境変数として設定してください- テストを実行し、Axe Developer Hub で結果を確認してください
あなたのテストフレームワークに特有の詳細なセットアップ手順については、フレームワーク固有のドキュメントページを参照してください。