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

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

    const controller = new WdioController(browser)
    wrapWdio(browser, controller)
  5. 最後に、Axe Watcher からのすべてのテスト結果がクリアされることを確認してください。これを行うために、以下のコードブロックをテストのティアダウンコード(通常は afterFetch ブロック内)に追加します。

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