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()
    })