axe-runner

1.6.1 • Public • Published

axe-runner

npm version

Puppeteerとaxe-coreで複数ページのアクセシビリティ検証を行い、結果をCSVファイルに出力します。

使用方法

事前にテスト対象のURLをXML形式のサイトマップ、もしくは1行1URLでURLを列挙したテキストファイルで準備してください。
結果はreportディレクトリに格納されます。

  1. npm install axe-runnerでインストールします
  2. npx axe-runner [filename of url list]を実行します(例: npx axe-runner urls.txt

※グローバルにインストールした場合はnpxをつけずに実行します。

axeやエミュレートに使用するデバイスの設定

カレントディレクトリのaxe-runner.config.jsに記述します。-cオプションで別の場所も指定できます。
設定方法はWikiのConfig File Exampleを参照してください。

npx axe-runner -c [設定ファイルへの相対パス] [filename of url list]

Basic認証への対応

.envに認証情報を記述します。

BASIC_AUTH_USERNAME=ユーザー名
BASIC_AUTH_PASSWORD=パスワード

コマンドライン初心者向け実行環境

コマンドライン操作が苦手な方のために、ワンクリックでaxe-runnerが実行できる環境を用意しました。Wikiの「コマンドライン初心者向け実行環境」をご覧ください。

補足

  • サーバーへのリクエストを行う際、リクエストとリクエストの間に3秒の待機時間を取ります(intervalで調整可能)
  • テストの内容や関連する達成方法については「WCAG 2.0達成基準とaxe-core Rule IDの対照表」にまとめましたのでご覧ください

参考サイト

開発にあたり参考にしたサイトです。貴重な情報をありがとうございます。

結果を記録したCSVファイル例

画面キャプチャ:axe-runnerを実行して出力されたCSVの様子

Package Sidebar

Install

npm i axe-runner

Weekly Downloads

1

Version

1.6.1

License

MIT

Unpacked Size

17 kB

Total Files

6

Last publish

Collaborators

  • hideki_a