「axe-test.js」は、Deque Systems, Inc. が開発、公開しているウェブアクセシビリティ検証ツール「axe」のコアエンジン「axe-core」を利用して、ウェブサイトのアクセシビリティ自動テストを実行するためのスクリプトです。Node.js ライブラリ「Puppeteer」と併せて使います。
ウェブサイト全体 (数百ページ規模) を対象に、一括処理でアクセシビリティを検証し、その結果を、日本語でスプレッドシート (.csv ファイル) に出力することができます。
Node.js のサイトから、Node.js のインストーラーをお使いのパソコンにダウンロードし、実行します。Node.js と npm (Node Package Manager) がインストールされます。
インストール完了後、ターミナル (コマンドプロンプト) で、以下を入力し、バージョンが表示されればOKです。
(実際の入力時は、「$」記号はタイプしません。以下、同様です。)
$ node -v
$ npm -v
アクセシビリティ自動テストを実行するためのフォルダを、お使いのパソコン上に作成します。 (例 : デスクトップ上に「axe-test」フォルダを作成する。)
ターミナル (コマンドプロンプト) の cd コマンドで、作成したフォルダに移動します。たとえば、デスクトップに「axe-test」フォルダを作成した場合は、以下のように入力します。
$ cd desktop/axe-test
その状態で、Puppeteer、axe-core (Puppeteer 用)、axe-reports をそれぞれ、以下のようにターミナル (コマンドプロンプト) で入力して、インストールします。
$ npm install puppeteer --no-save
$ npm install @axe-core/puppeteer
$ npm install axe-reports
上記で作成したフォルダ (例 : デスクトップ上の「axe-test」フォルダ) の中に、「node_modules」というフォルダが作成され、その中に「puppeteer」「@axe-core」「axe-core」「axe-reports」が格納されていればOKです。
上記で作成したアクセシビリティ自動テストを実行するためのフォルダ (例 : デスクトップ上の「axe-test」フォルダ) の中に、この GitHub リポジトリにある「axe-test.js」を置きます。複数のプロジェクトでアクセシビリティ自動テストを実施する場合は、プロジェクトごとに下位フォルダ (サブディレクトリ) を作成し、その中に「axe-test.js」を置く形でも結構です。
「axe-test.js」を置いたフォルダの同階層に、テスト対象となる URL 一覧を記載したテキストファイルを作成し、「urls.txt」というファイル名で保存します。テキストファイルの中身は、1行ごとに1つのURLを記述しただけのものにしてください。
(なお、Basic 認証が適用されているページに対してテストを実行する場合は、各行の URL 記述を https://userid:password@example.com/ という具合にします。)
ターミナル (コマンドプロンプト) の cd コマンドで、「axe-test.js」を置いたフォルダに移動します。たとえば、デスクトップ上の「axe-test」フォルダに置いてある場合は、以下のように入力します。
$ cd desktop/axe-test
その状態で、ターミナル (コマンドプロンプト) に以下を入力し、Enter キーを押してテストを実行します。
$ node axe-test.js => result.csv
node axe-test.js の記述は、「.js」を省いて node axe-test と記述する形でもOKです。
=> result.csv と記述することで、テスト結果がスプレッドシート (.csv ファイル) に出力されます。なお、.csv のファイル名は、必ずしも「result.csv」である必要はなく、任意のもので構いません。ちなみに => result.csv の記述がない場合、テスト結果はターミナル (コマンドプロンプト) 内に出力されます。
テストの実行には少し時間がかかると思います (数百ページ規模だと、数十分かかるかもしれません) が、完了すると、テストを実行したフォルダの中に .csv ファイルが生成されます。あとはこれを Excel や Google スプレッドシートで開いて、適宜ご活用ください。
「axe-test.js」では、下記の行 (45行目) で、テスト基準を設定しています。
const results = await new AxePuppeteer(page).configure(config).withTags(['wcag2a', 'wcag2aa', 'wcag21a', 'wcag21aa', 'best-practice']).analyze();
withTags() の中に ['wcag2a', 'wcag2aa', 'wcag21a', 'wcag21aa', 'best-practice'] と記述してあり、WCAG 2.1 (および 2.0) の、達成基準レベル A と AA に相当するテストルールを適用して、自動テストを実行する設定にしています。(加えて、一般的なアクセシビリティのベストプラクティスに関するテストルールも、適用する設定にしています。) 必要に応じて withTags() の記述を変更することで、テスト基準の設定を変更することができます。ここに記述可能なタグについては、axe API Documentation の 「Axe-core Tags」のセクション をご参照ください。