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

    npm install --save-dev @axe-core/watcher
  2. ファイルで、 wdio.config.js ファイルには、 wdioTestRunner() 関数、 wrapWdio() 関数、および WdioController クラスをインポートします: @axe-core/watcher/wdio

    const {
      wdioTestRunner,
      wrapWdio,
      WdioController
    } = require('@axe-core/watcher/wdio')
  3. WebdriverIOの設定をエクスポートする前に、APIキーを渡して wdioTestRunner() でラップしてください:

    exports.config = {
      // Your config options here...
    }
    
    // Becomes:
    
    const ACCESSIBILITY_API_KEY = process.env.ACCESSIBILITY_API_KEY
    const PROJECT_ID = process.env.PROJECT_ID
    
    exports.config = wdioTestRunner({
      axe: {
        apiKey: ACCESSIBILITY_API_KEY,
        projectId: PROJECT_ID
      }, {
        // Your config options here...
      }
    })

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

  4. テストセットアップコード内(通常は before または beforeAll ブロックで)、 WdioControllerインスタンスを作成し、 browser オブジェクトをラップします:

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

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