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

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

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

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

    ACCESSIBILITY_API_KEYPROJECT_IDを環境で設定し、個人用APIキー(axeアカウント内の**API KEYS**タブで見つかります)とプロジェクトID(プロジェクト作成時の手順の最上部か、プロジェクトページで**設定**の下にある**プロジェクトを設定**を選択して取得可能)にしてください。組織が地域的、プライベートクラウド、またはオンプレミスのAxe Developer Hubインスタンスを使用している場合は、そのインスタンスのベースURLをSERVER_URLに設定します(例: https://axe-eu.deque.com)。そうでない場合は、SERVER_URLを省略し、デフォルトのhttps://axe.deque.comが使用されます。

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

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

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

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