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

    npm install --save-dev @axe-core/watcher
  2. テストファイルまたはファイル群で、 webdriverConfig() 関数、 wrapWebdriver() 関数、および WebdriverController クラスをインポートします: @axe-core/watcher/webdriver

    const {
      webdriverConfig,
      wrapWebdriver,
      WebdriverController
    } = require('@axe-core/watcher/webdriver')
  3. テストセットアップコードを更新します(通常は before または beforeAll ブロック内)、Chromeのオプションを指定して browser インスタンスを生成し、APIキーを提供します:

    // Original code:
    let browser = await new Builder()
      .forBrowser('chrome')
      .build()
    
    // Becomes:
    const ACCESSIBILITY_API_KEY = process.env.ACCESSIBILITY_API_KEY
    const PROJECT_ID = process.env.PROJECT_ID
    
    let browser = await new Builder()
      .forBrowser('chrome')
      .setChromeOptions(
        webdriverConfig({
          axe: {
            apiKey: ACCESSIBILITY_API_KEY,
            projectId: PROJECT_ID
          }
        }
      )
      .build()

    必ず、ACCESSIBILITY_API_KEYPROJECT_IDを環境に設定し、あなたの個人用APIキー(AxeアカウントのAPI KEYSタブにあります)とプロジェクトID(プロジェクト作成時のこの手順の上部に表示されるか、プロジェクトページで設定の下にあるプロジェクトを設定を選択することで確認可能です)を使用してください。

  4. のインスタンスを作成します: WebdriverController

    const controller = new WebdriverController(browser)
  5. インスタンスを browser 関数でラップします: wrapWebdriver()

    browser = wrapWebdriver(browser, controller)
  6. 最後に、axe Watcherからのすべてのテスト結果がフラッシュアウトされることを確認します。そのためには、テストのティアダウンコード(通常は afterEach ブロック内)に次のコードブロックを追加します:

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