グローバル設定の使用
この記事では、axe Configuration のグローバル設定が axe Developer Hub とどのように連携するかを説明します
グローバル設定の概要
「 グローバル 」パネルは、 axe Configuration のアクセシビリティテストの設定を組織全体で管理および制御するための集中管理方式を提供します。この強力な機能により、企業の管理者は一貫したテスト基準を確立しながら、各チームや開発者が効率的に作業できる柔軟性を提供します。
グローバル設定とは?
グローバル設定(「 グローバル 」タブ)は、アクセシビリティテスト中の axe Developer Hub の動作を決定する制御セットです。これらの設定には以下が含まれます:
- テスト対象とするアクセシビリティ規格(例: WCAG 2.1 AA または EN 301 549)
- ベストプラクティスの チェックを含めるかどうか
- 実験的ルールを 有効にするかどうか
- テストに使用する axe-core のバージョン
これらの設定は、企業レベルおよび個々のユーザーレベルで管理可能で、柔軟かつ制御されたテスト環境を作成します。
グローバル設定を使用する理由
グローバル設定は、企業のアクセシビリティテストにおけるいくつかの一般的な課題を解決します:
- 一貫性:すべてのチームが同じアクセシビリティ基準に対してテストを行うことを保証
- コンプライアンス:組織全体で特定のテスト要件を強制
- 柔軟性:承認されたパラメータ内でチームがテストアプローチをカスタマイズできるように
- バージョン管理:プロジェクト全体で使用できる axe-core のバージョンを管理
- 品質保証:チーム固有の最適化を可能にしながらテスト基準を維持
グローバル設定の仕組み
管理者
管理者は、組織全体のデフォルトを設定し、ユーザーが変更できる設定を「 configurationOverrides 」オプションで定義します。これらの設定は、組織内の axe Developer Hub テストの基準を確立します。これらの設定は「 グローバル 」パネルで変更されます。 axe Configurationで変更されます。
「 グローバル 」パネルの一部の設定は、現在、axe Developer Hub には適用されません。これらの設定には以下が含まれます:
- デフォルトの要確認
- デフォルトの共有された問題のスクリーンショット
- デフォルトの機械学習
- 使用サービス
ユーザー
ユーザーは グローバル パネルを使用する代わりに、テスト設定コードの configurationOverrides オプションを変更または追加することでテスト設定をカスタマイズします。 configurationOverrides オプションは、 グローバル パネルで定義された設定と相互作用します。「 グローバル設定の共通シナリオと設定のオーバーライド」の表を参照してください。
APIリファレンス には、(JavaScript/TypeScript) configurationOverrides または (Java) ConfigurationsOverrides に関する詳細情報とそのプロパティが含まれています。
グローバル設定の共通シナリオと設定のオーバーライド
テストが実行されると、axe Developer Hub は企業とユーザーの設定を統合して最終的なテスト設定を作成します。これにより、すべてのカスタマイズは承認されたパラメーター内に維持されつつ、ユーザーには必要な柔軟性が提供されます。
次の表は、グローバル設定を操作する際によく遭遇するシナリオを示しています。各シナリオは、企業設定がプロジェクト設定とどのように相互作用するかを示しています。
| シナリオ | 達成したいこと | グローバル設定 | 自分の設定コード | 結果 |
|---|---|---|---|---|
| 基本的な使い方 | デフォルト標準を使用 | WCAG 2.0 AA(グローバル設定では変更不可) | 設定なし | ✅ テストはWCAG 2.0 AAを使用 |
| 許可されたオーバーライド | 異なる許可された標準を使用 | WCAG 2.0 AA、2.1 AAが使用可能 | configurationOverrides: { accessibilityStandard: 'WCAG 2.1 AA'} |
✅ テストはWCAG 2.1 AAを使用 |
| 許可されないオーバーライド | 許可されていない標準を使用 | WCAG 2.0 AAのみ | configurationOverrides: { accessibilityStandard: 'WCAG 2.1 AA' } |
❌ エラー: 標準が許可されていません |
| ベストプラクティスを有効にする | ベストプラクティスチェックを含める | ベストプラクティスが許可されている | configurationOverrides: { bestPractices: true } |
✅ テストにベストプラクティスが含まれます |
| 混合設定 | カスタムルールと標準を使用 | WCAG 2.0 AA(変更不能) | runOptions: { rules: { 'color-contrast': { enabled: false } } } |
⚠️ 動作するが警告を表示 |
| レガシー設定 | 旧スタイルの設定を使用 | 任意 | runOptions: { runOnly: { type: 'tag', values: ['WCAG 2.0 A'] } } |
⚠️ 動作するが警告を表示 |
| 無効な組み合わせ | 旧設定と新設定を混在 | 任意 | 両方を使用 configurationOverrides および runOptions.runOnly |
❌ エラー: 両方を使用することはできません |
結果の理解
- ✅ 成功: 設定が期待通りに動作しています
- ⚠️ 警告: 設定は動作しますが、推奨されません
- ❌ エラー: 設定は失敗します
推奨事項
- 常に
configurationOverridesよりも優先してくださいrunOptions。 - オーバーライドを設定する前に企業の設定を確認してください。
- 必要な場合のみ設定をオーバーライドしてください。
- あなたのニーズに合った最もシンプルな設定を使用してください。
設定オーバーライドの例
以下は、オーバーライドを示す設定例です。 WCAG 2.1 AA と ベストプラクティスに従うものです:
const config = {
axe: {
apiKey: 'YOUR_API_KEY',
projectId: 'YOUR_PROJECT_ID',
configurationOverrides: {
accessibilityStandard: 'WCAG 2.1 AA',
axeCoreVersion: '4.9.1',
experimentalRules: true,
bestPractices: true
}
};(JavaScript/TypeScript) を参照してください ConfigurationOverrides インターフェース または (Java) ConfigurationOverrides クラス をプロパティの説明として。
エラーと警告
エラー
非許可標準
許可されていない標準を使用しようとすると、サーバーレスポンスコード422、不可処理のコンテンツを受け取ります。例:
Error: Server responded to https://axe.deque.com/api-pub/watcher/sessions with status code 422: "error": "Invalid accessibility standard: WCAG 2.0 AA. Allowed options: EN 301 549, Trusted Tester v5"使用中 runOptions.runOnly と共に configurationOverrides
両方を使用する場合 runOptions.runOnly と共に configurationOverrides、テストはすぐに失敗します。 configurationOverridesのみを使用してください。
警告
使用中 runOptions.runOnly
を設定に使用する場合 runOptions.runOnly 、次の警告メッセージを受け取ります:
@axe-core/watcher グローバル設定サポートなし
のバージョンが古すぎてグローバル設定サポートがない場合 @axe-core/watcher 、次のメッセージを受け取ります:
関連項目
- axe 設定
- (JavaScript/TypeScript)
configurationOverridesリファレンス - (Java)
ConfigurationOverridesクラス


