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

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

    const {
      wdioConfig,
      wrapWdio,
      WdioController
    } = require('@axe-core/watcher/wdio')
  3. テストセットアップコード(通常は before または beforeAll ブロック)で、 browser インスタンスを作成する既存のコードを、次の呼び出しでラップします: wdioConfig()、APIキーを提供しながら:

    const ACCESSIBILITY_API_KEY = process.env.ACCESSIBILITY_API_KEY
    const PROJECT_ID = process.env.PROJECT_ID
    
    const browser = await wdio.remote(
      wdioConfig({
        axe: {
          apiKey: ACCESSIBILITY_API_KEY,
          projectId: PROJECT_ID
        }
      })
    )

    環境に ACCESSIBILITY_API_KEYPROJECT_ID を設定し、あなたの個人的なAPIキーに設定してください(Axeアカウントの API KEYS タブで見つけられます)、およびプロジェクトID(プロジェクトを作成した際のこれらの説明の上部に示されています。または、プロジェクトページで プロジェクトを設定 を選択し、 設定から確認できます)。

  4. 一旦 browser インスタンスを持ったら、 WdioController クラスのインスタンスを作成します:

    const controller = new WdioController(browser)
  5. 自身の browser インスタンスを wrapWdio() 関数でラップし、 browser インスタンスと controller インスタンスを提供します:

    wrapWdio(browser, controller)
  6. 最後に、axe Watcherからのすべてのテスト結果が出力されることを確認してください。これを行うには、テストのティアダウンコード(通常は afterEach ブロック)に次のコードブロックを追加します:

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