@wordpress/jest-puppeteer-axe

インストール

モジュールをインストールします

npm install @wordpress/jest-puppeteer-axe --save-dev

注意: このパッケージは長期サポートステータスのNode.jsバージョンを必要とします（アクティブLTSまたはメンテナンスLTSリリースを確認）。古いバージョンとは互換性がありません。

セットアップ

最も簡単なセットアップは、JestのsetupFilesAfterEnv設定オプションを使用することです:

"jest": {
  "setupFilesAfterEnv": [
   "@wordpress/jest-puppeteer-axe"
  ]
},

使用法

Jestテストスイートに次のコードをテストの本体に追加します:

test( 'checks the test page with Axe', async () => {
   // First, run some code which loads the content of the page.
   loadTestPage();
   await expect( page ).toPassAxeTests();
} );

オプションのパラメータを渡すことも可能で、Axe APIがカスタマイズされたチェックを実行できるようになります:

• include – 分析に含める要素のリストを追加するCSSセレクター。
• exclude – 分析から除外する要素のリストを追加するCSSセレクター。
• disabledRules – 検証からスキップするAxeルールのリスト。
• options – Axeの実行方法を構成する柔軟な方法。オブジェクト構造に関する情報はaxe-core APIドキュメントを参照してください。
• config – Axe設定オブジェクト。オブジェクト構造に関するドキュメントはaxe-core APIドキュメントを参照してください。

test( 'checks the test component with Axe excluding some button', async () => {
   // First, run some code which loads the content of the page.
   loadPageWithTestComponent();
   await expect( page ).toPassAxeTests( {
   include: '.test-component',
   exclude: '.some-button',
   disabledRules: [ 'aria-allowed-role' ],
   options: { iframes: false },
   config: { reporter: 'raw' },
   } );
} );

このパッケージへの貢献

これはGutenbergプロジェクトの一部である個別のパッケージです。このプロジェクトはモノレポとして整理されています。特定の目的を持つ複数の自己完結型ソフトウェアパッケージで構成されています。このモノレポ内のパッケージはnpmに公開され、WordPressや他のソフトウェアプロジェクトで使用されています。

このパッケージやGutenberg全体への貢献について詳しく知りたい場合は、プロジェクトの主要な貢献者ガイドをお読みください。