Axe DevTools for Web v4.xへの移行（Node.js向け）

Axe DevTools NPM v4.xはプロジェクト全体の大きな書き直しです。最も注目すべき変更点を以下にまとめ、その後に関連するパッケージへの具体的な変更を示します。

概要

npmパッケージのaxe-devtools-*スイートは、ブランドの視点を再定義し、開発者の体験に特化するために統合ツールを統一しました。

これを念頭に置き、すべてのパッケージはaxe devtoolsネームスペースを利用するように再ブランド化され、バイナリは単一のバイナリパッケージにまとめられました。

注意：破壊的変更

APIの再ブランド化を踏まえて、v4.0への移行はこの移行ガイドに従って段階的に進める必要があります。

環境設定

デフォルトの要件に変更はありません。望ましい要件は以下の通りです：

• Node LTSバージョン
• npm依存関係に対するNPM

Axe DevTools NPMパッケージのインストール

Deque's registryにアクセスできることを確認してください。アクセスできない場合は、パッケージのインストール情報を参照してください：

• ブラウザJS
• Cypress
• Playwright
• Puppeteer
• WebdriverIO
• WebDriverJS

以下のnpmパッケージをpackage.jsonファイルに含めることでインストールできます。

npm install @axe-devtools/browser

// package.json
{
  "@axe-devtools/browser": "^4.0.0"
}

利用可能なnpmパッケージは次の通りです：

• Axe DevTools CLI
• Axe DevTools Puppeteer
• Axe DevTools Reporter
• Axe DevTools WebdriverIO
• Axe DevTools WebDriverJS

それぞれのnpmパッケージの使用方法や詳細なAPIドキュメントは、対応するドキュメントを参照してください。

オプションとして、以下のコマンドを実行することで以前のNodeインテグレーション（スコープ付きまたはスコープなしのパッケージ）をアンインストールすることができます：

npm uninstall attest-js
npm uninstall @deque/attest-js

注目すべき変更点

インストールや使用の変更に加え、注目すべき変更点としては以下があります：

• カスタムルールを設定するための環境変数がATTEST_PATHからAXE_RULESET_PATHに変更されました。
• デフォルトのルールセットが変更されました。Axe DevToolsはwcag2をデフォルトのルールセットとしてページを監査します。エンドユーザーによる変更は必要ありません。異なるルールセットを設定したい場合は、@axe-devtools/cliを使用して異なるルールセットを生成するか、望ましいルールセットを含むaxe-ruleset.jsonファイルを作成することができます。
• すべてのパッケージがaxe-core v4.0.Xを利用します。
• Axe DevTools WebdriverIOは、WebdriverIO v4をサポートしなくなり、今後はWebdriverIO v5とv6のみをサポートします。

バイナリの変更

Attest-standardsとAttest Reporterはバイナリとして出荷されなくなります。以前のバイナリの機能はすべて、@axe-devtools/cliのサブコマンドとして含まれます。Axe DevTools 4.0では、Attest-standardsは廃止され、4.0リリースはありません。