1. テストフォルダのルートレベルに、 @axe-core/watcher パッケージとそのすべての依存関係をインストールします。 npm またはお好みのパッケージマネージャを使用します(例: yarn または pnpm)。

    npm install --save-dev @axe-core/watcher
  2. テストファイル内で、 wdioConfig() 関数、 wrapWdio() 関数、および WdioController クラスをインポートします: @axe-core/watcher/wdio

    const {
      wdioConfig,
      wrapWdio,
      WdioController
    } = require('@axe-core/watcher/wdio')
  3. テストセットアップコード(通常は before または beforeAll ブロック)で、 browser インスタンスを作成する既存のコードを、次の呼び出しでラップします: wdioConfig()、APIキーを提供しながら:

    const ACCESSIBILITY_API_KEY = process.env.ACCESSIBILITY_API_KEY
    const PROJECT_ID = process.env.PROJECT_ID
    
    const browser = await wdio.remote(
      wdioConfig({
        axe: {
          apiKey: ACCESSIBILITY_API_KEY,
          projectId: PROJECT_ID
        }
      })
    )

    必ず環境で ACCESSIBILITY_API_KEYPROJECT_ID を設定し、自分のAPIキー(axeアカウントで見つかります、 **API KEYS** タブ)とプロジェクトID(プロジェクトを作成したときのこれらの指示の上部に表示されるか、 **プロジェクトの構成** を選択してプロジェクトページから利用可能です) **設定**の下にあります。

  4. 一旦 browser インスタンスを持ったら、 WdioController クラスのインスタンスを作成します:

    const controller = new WdioController(browser)
  5. 自身の browser インスタンスを wrapWdio() 関数でラップし、 browser インスタンスと controller インスタンスを提供します:

    wrapWdio(browser, controller)
  6. 最後に、axe Watcherからのすべてのテスト結果が出力されることを確認してください。これを行うには、テストのティアダウンコード(通常は afterEach ブロック)に次のコードブロックを追加します:

    afterEach(async () => {
      await controller.flush()
    })