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

    npm install --save-dev @axe-core/watcher
  2. wdio.config.ts ファイルにて、wdioTestRunner() 関数、wrapWdio() 関数、WdioController クラスを @axe-core/watcher/wdio からインポートしてください:

    import {
      wdioTestRunner,
      wrapWdio,
      WdioController
    } from '@axe-core/watcher/wdio'
  3. WebdriverIO の設定をエクスポートする前に、APIキーを使って wdioTestRunner() を呼び出してラップしてください:

    // Original code:
    
    export const config = {
      // Your config options here...
    }
    
    // Becomes:
    
    const ACCESSIBILITY_API_KEY = process.env.ACCESSIBILITY_API_KEY
    const PROJECT_ID = process.env.PROJECT_ID
    const SERVER_URL = process.env.SERVER_URL
    
    export const config = wdioTestRunner({
      axe: {
        apiKey: ACCESSIBILITY_API_KEY,
        projectId: PROJECT_ID,
        serverURL: SERVER_URL
      }, {
        // Your config options here...
      }
    })

    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. テストセットアップコード(通常は beforebeforeAll ブロック内)では、WdioController クラスのインスタンスを作成し、次に browser オブジェクトをラップします:

    const controller = new WdioController(browser)
    wrapWdio(browser, controller)
  5. 最後に、axe Watcher からのすべてのテスト結果を確実にフラッシュしてください。そのためには、テストの終了処理コード(通常 afterFetch ブロック内)に次のコードを追加します:

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