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

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

    import {
      wdioConfig,
      wrapWdio,
      WdioController
    } from '@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 SERVER_URL = process.env.SERVER_URL
    
    const browser = await remote(
      wdioConfig({
        axe: {
          apiKey: ACCESSIBILITY_API_KEY,
          projectId: PROJECT_ID,
          serverURL: SERVER_URL
        }
      })
    )

    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. browserインスタンスを取得したら、WdioControllerクラスのインスタンスを作成します。

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

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

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