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