Repolode
dequelabs

dequelabs/axe-core-npm

axe-coreのアクセシビリティエンジンをCLIツール、ブラウザー自動化フレームワーク、React、WebDriverのテストスイートに組み込むnpmパッケージ群です。

スター
731
フォーク
80
未解決の Issue
103
最終コミット
11 時間前

これは何?

axe-core-npmは、axe-coreエンジンを使ったアクセシビリティの自動チェックを実行する、7つのnpmパッケージからなるモノレポです。各パッケージは、Webテストがすでに実行されている環境に合わせて作られており、既存のエンドツーエンドテストやコンポーネントテストと一緒にアクセシビリティルールを実行できます。

パッケージには、コマンドライン実行ツール(@axe-core/cli)、Playwright、Puppeteer、WebDriverIO、WebdriverJSとの連携機能、開発中に違反を報告するReact用ヘルパー、構造化出力に対応したEARL reporterがあります。開発者は利用中のツールに合ったパッケージをインストールし、エンジンを手動で組み込む代わりに、テストコードからaxeを呼び出します。

このプロジェクトはDeque Systemsが保守しており、pnpmを使って開発されています。リポジトリのルートにはlintとformatのスクリプトがあります。インストール方法、使い方、設定の詳細は各パッケージのREADMEに記載されています。

主な機能

  • 01Playwright、Puppeteer、WebDriverIO、WebdriverJSのテスト内でaxe-coreのアクセシビリティルールを実行します。
  • 02コマンドラインからページを直接チェックするCLIを提供します。
  • 03開発中にアクセシビリティ違反を検出できるReact連携機能を含みます。
  • 04アクセシビリティの結果を構造化して出力するEARL reporterを提供します。

ユースケース

  • 既存のPlaywrightまたはPuppeteerのエンドツーエンドテストスイートに、アクセシビリティのアサーションを追加する。
  • CIスクリプトでコマンドライン実行ツールを使ってページをスキャンする。
  • ローカル開発中にReactコンポーネントのアクセシビリティのリグレッションを検出する。

クイックスタート

  1. 1

    pnpmでmonorepoの依存関係をインストールする

    pnpm install
  2. 2

    リンターを実行する

    pnpm run lint
  3. 3

    コードフォーマッターを実行する

    pnpm run fmt
  4. 4

    インストール方法と使い方については、必要なパッケージのREADMEを確認する

使う前に知っておきたいこと

  • これはwrapper packageのmonorepoなので、使用するツールに対応した個別のパッケージをインストールする必要があります。
  • ローカル開発にはpnpmパッケージマネージャーが必要です。

収録されている特集

トピック

よくある質問

axe-core-npm とは?
axe-coreのアクセシビリティエンジンをCLIツール、ブラウザー自動化フレームワーク、React、WebDriverのテストスイートに組み込むnpmパッケージ群です。 axe-core-npmは、axe-coreエンジンを使ったアクセシビリティの自動チェックを実行する、7つのnpmパッケージからなるモノレポです。各パッケージは、Webテストがすでに実行されている環境に合わせて作られており、既存のエンドツーエンドテストやコンポーネントテストと一緒にアクセシビリティルールを実行できます。
axe-core-npm は無料で使えますか?ライセンスは?
axe-core-npm は MPL-2.0 ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
axe-core-npm は今もメンテナンスされていますか?
活発にメンテナンス中。axe-core-npm の最終コミットは 2026年11月6日 です。
axe-core-npm は何に使えますか?
既存のPlaywrightまたはPuppeteerのエンドツーエンドテストスイートに、アクセシビリティのアサーションを追加する。 CIスクリプトでコマンドライン実行ツールを使ってページをスキャンする。 ローカル開発中にReactコンポーネントのアクセシビリティのリグレッションを検出する。
axe-core-npm のインストール方法は?
pnpmでmonorepoの依存関係をインストールする: pnpm install リンターを実行する: pnpm run lint コードフォーマッターを実行する: pnpm run fmt インストール方法と使い方については、必要なパッケージのREADMEを確認する
axe-core-npm はどこで入手できますか?
ソースコードとインストール手順は GitHub にあります:https://github.com/dequelabs/axe-core-npm

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト