テストフォルダのルートレベルで、@axe-core/watcherパッケージとそのすべての依存関係をnpmまたはお好みのパッケージマネージャー(例えば、yarnやpnpm)を使用してインストールします。
npm install --save-dev @axe-core/watchercypress.config.tsで、cypressConfig()関数を@axe-core/watcherパッケージからインポートし、その関数で設定をラップします。testingTypes配列にcomponentを含めるように設定してください。
import { defineConfig } from 'cypress';
import { cypressConfig } from '@axe-core/watcher/cypress/config';
const ACCESSIBILITY_API_KEY = process.env.ACCESSIBILITY_API_KEY
const PROJECT_ID = process.env.PROJECT_ID
const SERVER_URL = process.env.SERVER_URL
export default defineConfig(
cypressConfig({
axe: {
apiKey: ACCESSIBILITY_API_KEY,
projectId: PROJECT_ID,
serverURL: SERVER_URL,
testingTypes: ['component']
},
// Your existing Cypress configuration code here
component: {
// Your component testing configuration
// For example:
// devServer: {
// framework: 'react',
// bundler: 'webpack',
//},
},
})
);ACCESSIBILITY_API_KEY と PROJECT_ID を環境に設定し、個人用 API キー(Axe アカウントの**API KEYS**タブで見つかります)とプロジェクト ID(プロジェクトを作成した際にこれらの指示の上部に表示されるか、プロジェクトページで**プロジェクトを設定**を選択して**設定**から入手できます)を使用してください。組織が地域のプライベートクラウドやオンプレミスの Axe Developer Hub インスタンスを使用している場合は、そのインスタンスのベース URL をSERVER_URLに設定してください(例: https://axe-eu.deque.com)。それ以外の場合、SERVER_URLを省略し、デフォルトのhttps://axe.deque.comが使用されます。
Cypressのコンポーネントサポートファイル(一般的にはcypress/support/component.tsと呼ばれます)で、@axe-core/watcher/cypress/supportをインポートし、各テストの後にaxeWatcherFlush()を呼び出します。
import '@axe-core/watcher/cypress/support';
afterEach(() => {
cy.axeWatcherFlush();
});これで完了です。コンポーネントテストを実行し、結果を確認してください。なお、@axe-core/watcherはChrome for TestingまたはChromiumでのみ実行され、Cypressの実行モードでのみ使用する必要があります。--headless=newまたは--headed(例: cypress run --headed --browser=chrome-for-testing --component)と共に使用することができます。