Utilisation des configurations globales

Link to Utilisation des configurations globales copied to clipboard

Cet article décrit comment la configuration globale d'axe Configuration fonctionne avec axe Developer Hub

Free Trial
Not for use with personal data

Présentation des configurations globales

Le panneau Global de axe Configuration fournit un moyen centralisé de gérer et de contrôler les paramètres de test d'accessibilité dans toute votre organisation. Cette fonctionnalité puissante permet aux administrateurs d’entreprise d’établir des normes de test cohérentes tout en offrant aux équipes et aux développeurs individuels la flexibilité dont ils ont besoin pour travailler efficacement.

Que sont les configurations globales ?

Les configurations globales (l'onglet Global de la configuration axe) sont un ensemble de contrôles qui déterminent le fonctionnement d'axe Developer Hub pendant les tests d'accessibilité. Ces paramètres incluent :

Ces paramètres peuvent être gérés à la fois au niveau de l’entreprise et au niveau de l’utilisateur individuel, créant ainsi un environnement de test flexible mais contrôlé.

Pourquoi utiliser des configurations globales ?

Les configurations globales résolvent plusieurs défis courants dans les tests d’accessibilité en entreprise :

  • Cohérence : Assurez-vous que toutes les équipes effectuent des tests selon les mêmes normes d'accessibilité
  • Conformité : Appliquez des exigences de test spécifiques à l'ensemble de votre organisation
  • Flexibilité : Permettre aux équipes de personnaliser leur approche de test dans les paramètres approuvés
  • Contrôle de version : gérer les versions d'axe-core qui peuvent être utilisées dans les projets
  • Assurance qualité : maintenir les normes de test tout en permettant des optimisations spécifiques à l'équipe

Comment fonctionnent les configurations globales

Administrateurs

Les administrateurs définissent les valeurs par défaut à l'échelle de l'organisation et définissent les paramètres que les utilisateurs peuvent modifier via l'option configurationOverrides . Ces paramètres établissent la base de référence pour les tests d'axe Developer Hub au sein de l'organisation. Ces paramètres sont modifiés dans le panneau de Global Configuration axe.

note

Certains paramètres du panneau de Global ne s'appliquent actuellement pas à axe Developer Hub. Ces paramètres incluent :

  • La valeur par défaut doit être révisée
  • Captures d'écran des problèmes partagés par défaut
  • Apprentissage automatique par défaut
  • Service d'utilisation

Utilisateurs

Au lieu d'utiliser le panneau Global , les utilisateurs individuels personnalisent leur configuration de test en modifiant ou en ajoutant l'option configurationOverrides dans leur code de configuration de test. L'option interagit avec les paramètres du panneau global tels que définis dans le tableau de [Scénarios de configuration globale et de remplacement de configuration communs]. configurationOverrides **** (#common-global-configuration-and-configuration-override-scenarios)

La référence API inclut plus d'informations sur configurationOverrides et ses propriétés.

Scénarios courants de configuration globale et de remplacement de configuration

Lorsqu'un test s'exécute, axe Developer Hub fusionne les paramètres d'entreprise et d'utilisateur pour créer la configuration de test finale. Cela garantit que toutes les personnalisations restent dans les paramètres approuvés tout en offrant aux utilisateurs la flexibilité nécessaire.

Le tableau suivant illustre les scénarios courants que vous rencontrerez lorsque vous travaillerez avec des configurations globales. Chaque scénario montre comment les paramètres d’entreprise interagissent avec la configuration de votre projet.

Scénario Ce que vous voulez faire Configuration globale Votre code de configuration Résultat
Utilisation de base Utiliser la norme par défaut WCAG 2.0 AA (immuable dans la configuration globale) Aucune configuration spécifiée ✅ Tests exécutés selon WCAG 2.0 AA
Remplacement autorisé Utiliser une norme autorisée différente WCAG 2.0 AA, peut utiliser 2.1 AA configurationOverrides: { accessibilityStandard: 'WCAG 2.1 AA'} ✅ Tests exécutés selon WCAG 2.1 AA
Remplacement non autorisé Utiliser une norme non autorisée WCAG 2.0 AA uniquement configurationOverrides: { accessibilityStandard: 'WCAG 2.1 AA' } ❌ Erreur : norme non autorisée
Activer les meilleures pratiques Inclure les contrôles des meilleures pratiques Meilleures pratiques permises configurationOverrides: { bestPractices: true } ✅ Les tests incluent les meilleures pratiques
Configuration mixte Utiliser des règles personnalisées avec le standard WCAG 2.0 AA (immuable) runOptions: { rules: { 'color-contrast': { enabled: false } } } ⚠️ Fonctionne mais affiche un avertissement
Configuration héritée Utiliser la configuration à l'ancienne Tout runOptions: { runOnly: { type: 'tag', values: ['WCAG 2.0 A'] } } ⚠️ Fonctionne mais affiche un avertissement
Combinaison invalide Mélanger les anciennes et les nouvelles configurations Tout En utilisant à la fois configurationOverrides et runOptions.runOnly ❌ Erreur : impossible d'utiliser les deux

Comprendre les résultats

  • ✅ Succès : la configuration fonctionne comme prévu
  • ⚠️ Attention : la configuration fonctionne mais n'est pas recommandée
  • ❌ Erreur : la configuration échouera

Recommandations

  1. Préférez toujours configurationOverrides à runOptions.
  2. Vérifiez les paramètres de votre entreprise avant de configurer les remplacements.
  3. Ne remplacez les paramètres que lorsque cela est nécessaire.
  4. Utilisez la configuration la plus simple qui répond à vos besoins.

Exemple de remplacement de configuration

Voici un exemple de configuration qui illustre les remplacements à suivre WCAG 2.1 AA et les meilleures pratiques :

const config = {
  axe: {
    apiKey: 'YOUR_API_KEY',

    configurationOverrides: {
      accessibilityStandard: 'WCAG 2.1 AA',
      axeCoreVersion: '4.9.1',
      experimentalRules: true,
      bestPractices: true
    }
};

Voir ConfigurationOverrides Interface pour une explication des propriétés.

Erreurs et avertissements

Erreurs

Normes non autorisées

Si vous essayez d'utiliser une norme qui n'est pas autorisée, vous recevrez un code de réponse du serveur 422, Entité non traitable. Exemple de message :

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"
Utilisation runOptions.runOnly avec configurationOverrides

Si vous utilisez les deux runOptions.runOnly avec configurationOverrides, vos tests échoueront immédiatement. Utiliser uniquement configurationOverrides.

Avertissements

Utilisant runOptions.runOnly

Si vous utilisez runOptions.runOnly dans votre configuration, vous recevrez ce message d'avertissement :

Capture d'écran montrant un avertissement dans axe Developer Hub suite à l'utilisation de runOptions.runOnly.

@axe-core/watcher Sans prise en charge de la configuration globale

Si vous utilisez une version de @axe-core/watcher qui est trop ancienne pour bénéficier de la prise en charge de la configuration globale, vous recevrez ce message :

Capture d'écran montrant le message qui se produit lorsque le package @axe-core/watcher est trop ancien pour prendre en charge les configurations globales

Voir aussi