WebdriverIO Testrunner と TypeScript の手引き

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

npm install --save-dev @axe-core/watcher

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

import {
  wdioTestRunner,
  wrapWdio,
  WdioController
} from '@axe-core/watcher/wdio'

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_KEY と PROJECT_ID を環境に設定し、個人用 API キー（Axe アカウントの**API KEYS**タブで見つかります）とプロジェクト ID（プロジェクトを作成した際にこれらの指示の上部に表示されるか、プロジェクトページで**プロジェクトを設定**を選択して**設定**から入手できます）を使用してください。組織が地域のプライベートクラウドやオンプレミスの Axe Developer Hub インスタンスを使用している場合は、そのインスタンスのベース URL をSERVER_URLに設定してください（例: https://axe-eu.deque.com）。それ以外の場合、SERVER_URLを省略し、デフォルトのhttps://axe.deque.comが使用されます。

テストセットアップコード（通常は before や beforeAll ブロック内）では、WdioController クラスのインスタンスを作成し、次に browser オブジェクトをラップします:

const controller = new WdioController(browser)
wrapWdio(browser, controller)

最後に、Axe Watcher のすべてのテスト結果がフラッシュされていることを確認します。そのためには、以下のコードブロックをテストのティアダウンコード（通常は afterFetch ブロック内に）に追加します。

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