グローバル設定

This page is not available in the language you requested. You have been redirected to the English version of the page.
Link to this page copied to clipboard

この記事では、Axe Configurationのグローバル設定がAxe Developer Hubとどのように連携するかを説明します

Not for use with personal data

グローバル設定の概要

グローバルパネルは、Axe Configurationを介して組織全体のアクセシビリティテスト設定を一元管理および制御する方法を提供します。この強力な機能は、エンタープライズ管理者が一貫したテスト標準を確立することを可能にしながら、個々のチームと開発者が効果的に作業できる柔軟性を提供します。

グローバル設定とは?

グローバル設定 (Axe Configurationのグローバルタブ) は、Axe Watcher がアクセシビリティテストを行う際にどのように動作するかを決定するコントロール群です。これらの設定には以下が含まれます:

  • どのアクセシビリティ基準に対してテストを行うか(WCAG 2.1 AAEN 301 549など)
  • ベストプラクティスチェックを含めるかどうか
  • 実験的ルールを有効にするかどうか
  • テストに使用するaxe-coreのバージョン

これらの設定は、エンタープライズレベルと個々のユーザーレベルの両方で管理可能であり、柔軟だが制御されたテスト環境を作成します。

グローバル設定を使う理由

グローバル設定は、企業のアクセシビリティテストでよくある課題を解決します:

  • 一貫性:全てのチームが同じアクセシビリティ基準に従ってテストすることを保証します
  • コンプライアンス:組織全体で特定のテスト要件を強制します
  • 柔軟性:承認されたパラメータ内でチームがテスト方法をカスタマイズできるようにします
  • バージョン管理:プロジェクト全体で使用できるaxe-coreのバージョンを管理します
  • 品質保証:チーム固有の最適化を可能にしながらテスト基準を維持します

グローバル設定の機能

管理者

管理者は組織全体のデフォルトを設定し、configurationOverridesプロパティ(JavaScript/TypeScript)またはAxeWatcherOptions.setConfgurationOverrides()メソッド(Java)を介してユーザーが変更できる設定を定義します。これらの設定は、組織内のAxe Watcherテストの基準を確立します。これらの設定はグローバルパネルのAxe Configurationで変更されます。

note

グローバルパネルのすべての設定が現在Axe Developer Hub(またはAxe Watcher)に適用されるわけではありません。適用される設定には以下が含まれます:

  • デフォルトのアクセシビリティ基準
  • デフォルトのaxe-coreバージョン
  • デフォルトのベストプラクティス
  • デフォルトの実験的ルール
  • 共有レポートアクセス制御

ユーザー

個別のユーザーは、自分のテスト設定コードでconfigurationOverridesオプションを変更または追加することによって、組織の管理者が設定した値とは異なる値を選択することでAxe Watcherをカスタマイズします(ただし、管理者がユーザーが変更を許可チェックボックスをオンにした設定のみ)。

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'] } } ⚠️ 機能するが警告を表示
無効な組み合わせ 旧式と新しい設定を混在させる 任意 configurationOverridesrunOptions.runOnlyの両方を使用 ❌ エラー: 両方を使用することはできません
ancestryを使用 動的セレクタを使用する必要があります 任意 configurationOverridesrunOptions.ancestry = trueの両方を使用 runOptions.runOnlyrunOptions.rulesが設定されていない限り機能します。

結果の理解

  • ✅ 成功: 構成は期待通りに機能します
  • ⚠️ 警告: 構成は機能するが推奨されません
  • ❌ エラー: 構成は失敗します

推奨事項

  1. 常にconfigurationOverridesrunOptionsより優先してください。
  2. 上書きを設定する前に、エンタープライズ設定を確認してください。
  3. 必要な場合のみ設定を上書きしてください。
  4. 必要に応じた最もシンプルな設定を使用してください。

設定上書きの例

WCAG 2.1 AAに従う上書きを示す設定例として、axe-coreをバージョン4.9.1に設定し、実験的なルールベストプラクティスを許可します。

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.runOnlyconfigurationOverridesの使用

runOptions.runOnlyconfigurationOverridesを同時に使用すると、テストは即座に失敗します。

警告

runOptionsrunOnlyまたはrulesの使用

runOptionsオブジェクトにrunOnlyまたはrulesプロパティを設定すると、このメッセージが表示されます。

This scan was created using runOptions. This may not be aligned with your organization's global configurations.

runOnlyまたはrulesを使用すると、組織が使用しているグローバル設定で許可されていないアクセシビリティルールを使用できる可能性があります。

note

runOptionsとともにancestryプロパティのみを使用し(trueに設定)、rulesrunOnlyプロパティを設定しない場合、この警告は表示されません。

グローバル設定サポートなしの@axe-core/watcher

グローバル設定をサポートするには古すぎる@axe-core/watcherバージョンを使用すると、このメッセージが表示されます。

@axe-core/watcherパッケージがグローバル設定をサポートするには古すぎる場合に発生するメッセージのスクリーンショット

関連項目