Verwendung globaler Konfigurationen
Dieser Artikel beschreibt, wie die globale Konfiguration von axe Configuration mit axe Developer Hub funktioniert
Übersicht über globale Konfigurationen
Das Globale Panel der axe Configuration bietet eine zentrale Möglichkeit, die Einstellungen für Barrierefreiheitstests in Ihrem gesamten Unternehmen zu verwalten und zu steuern. Mit dieser leistungsstarken Funktion können Unternehmensadministratoren einheitliche Teststandards festlegen und gleichzeitig einzelnen Teams und Entwicklern die Flexibilität geben, die sie für effektives Arbeiten benötigen.
Was sind globale Konfigurationen?
Globale Konfigurationen (die Registerkarte Global der axe-Konfiguration) sind eine Reihe von Steuerelementen, die bestimmen, wie der axe Developer Hub während Barrierefreiheitstests arbeitet. Zu diesen Einstellungen gehören:
– Welche Barrierefreiheitsstandards getestet werden (z. B. WCAG 2.1 AA oder EN 301 549)
- Ob Best Practices Prüfungen einbezogen werden sollen
- Ob [experimentelle Regeln] aktiviert werden sollen(dh-glossary#experimental-rules)
- Welche Version von axe-core soll zum Testen verwendet werden?
Diese Einstellungen können sowohl auf Unternehmens- als auch auf Einzelbenutzerebene verwaltet werden, wodurch eine flexible, aber kontrollierte Testumgebung entsteht.
Warum Globale Konfigurationen verwenden?
Globale Konfigurationen lösen mehrere häufige Herausforderungen bei Barrierefreiheitstests in Unternehmen:
- Konsistenz: Stellen Sie sicher, dass alle Teams nach den gleichen Barrierefreiheitsstandards testen
- Compliance: Setzen Sie unternehmensweit spezifische Testanforderungen durch
- Flexibilität: Ermöglichen Sie Teams, ihren Testansatz innerhalb genehmigter Parameter anzupassen
- Versionskontrolle: Verwalten Sie, welche axe-core-Versionen projektübergreifend verwendet werden können
- Qualitätssicherung: Halten Sie Teststandards aufrecht bei gleichzeitiger Ermöglichung teamspezifischer Optimierungen
So funktionieren globale Konfigurationen
Administratoren
Administratoren legen organisationsweite Standardeinstellungen fest und definieren, welche Einstellungen Benutzer über die Option configurationOverrides
ändern können. Diese Einstellungen bilden die Grundlage für axe Developer Hub-Tests innerhalb der Organisation. Diese Einstellungen werden im Bereich Global der axe-Konfiguration geändert.
Einige Einstellungen im Global -Bereich gelten derzeit nicht für den axe Developer Hub. Zu diesen Einstellungen gehören:
- Standard muss überprüft werden
- Standardmäßige Screenshots freigegebene Probleme
- Standard-Maschinelles Lernen
- Nutzungsdienst
Benutzer
Anstatt das globales Bedienfeld zu verwenden, können einzelne Benutzer ihre Testkonfiguration anpassen, indem sie die configurationOverrides
option in ihrem Test-Setup-Code ändern oder hinzufügen. Die configurationOverrides
Option interagiert mit den Einstellungen im Global Panel, wie in der Tabelle unter Allgemeine Szenarien für globale Konfiguration und Konfigurationsüberschreibung definiert.
Die API-Referenz enthält weitere Informationen zu configurationOverrides
und seinen Eigenschaften.
Allgemeine Szenarien für globale Konfiguration und Konfigurationsüberschreibung
Wenn ein Test ausgeführt wird, führt axe Developer Hub Unternehmens- und Benutzereinstellungen zusammen, um die endgültige Testkonfiguration zu erstellen. Dadurch wird sichergestellt, dass alle Anpassungen innerhalb der genehmigten Parameter bleiben und den Benutzern gleichzeitig die erforderliche Flexibilität geboten wird.
Die folgende Tabelle veranschaulicht häufige Szenarien, die beim Arbeiten mit globalen Konfigurationen auftreten. Jedes Szenario zeigt, wie Unternehmenseinstellungen mit Ihrer Projektkonfiguration interagieren.
Szenario | Was Sie tun möchten | Globale Konfiguration | Ihr Konfigurationscode | Ergebnis |
---|---|---|---|---|
Grundlegende Verwendung | Verwenden Sie den Standard | WCAG 2.0 AA (unveränderbar in der globalen Konfiguration) | Keine Konfiguration angegeben | ✅ Tests werden mit WCAG 2.0 AA durchgeführt |
Zulässiges Überschreiben | Verwenden Sie einen anderen zulässigen Standard | WCAG 2.0 AA, kann 2.1 AA verwenden | configurationOverrides: { accessibilityStandard: 'WCAG 2.1 AA'} |
✅ Tests werden mit WCAG 2.1 AA durchgeführt |
Unbefugte Übersteuerung | Verwenden Sie einen nicht autorisierten Standard | Nur WCAG 2.0 AA | configurationOverrides: { accessibilityStandard: 'WCAG 2.1 AA' } |
❌ Fehler: Standard nicht zulässig |
Best Practices aktivieren | Integrieren Sie Best-Practice-Prüfungen | Best Practices sind erlaubt | configurationOverrides: { bestPractices: true } |
✅ Tests beinhalten Best Practices |
Gemischte Konfiguration | Verwenden Sie benutzerdefinierte Regeln zusammen mit dem Standard | WCAG 2.0 AA (unveränderlich) | runOptions: { rules: { 'color-contrast': { enabled: false } } } |
⚠️ Funktioniert, zeigt aber eine Warnung an |
Legacy-Konfiguration | Verwenden Sie die Konfiguration im alten Stil | Alle | runOptions: { runOnly: { type: 'tag', values: ['WCAG 2.0 A'] } } |
⚠️ Funktioniert, zeigt aber eine Warnung an |
Ungültige Kombination | Mischen Sie alte und neue Konfigurationen | Alle | Verwenden Sie sowohl configurationOverrides als auch runOptions.runOnly |
❌ Fehler: Beide können nicht gleichzeitig verwendet werden |
Verständnis der Ergebnisse
- ✅ Erfolg: Konfiguration funktioniert wie erwartet
- ⚠️ Warnung: Die Konfiguration funktioniert, wird aber nicht empfohlen
- ❌ Fehler: Die Konfiguration schlägt fehl
Empfehlungen
- Immer
configurationOverrides
vorrunOptions
bevorzugen. - Überprüfen Sie Ihre Unternehmenseinstellungen, bevor Sie Außerkraftsetzungen konfigurieren.
- Überschreiben Sie Einstellungen nur, wenn es nötig ist.
- Verwenden Sie die einfachste Konfiguration, die Ihren Anforderungen entspricht.
Beispielkonfigurationsüberschreibung
Hier sehen Sie eine Beispielkonfiguration, die zeigt, wie Sie WCAG 2.1 AA und Best Practices anwenden können:
const config = {
axe: {
apiKey: 'YOUR_API_KEY',
configurationOverrides: {
accessibilityStandard: 'WCAG 2.1 AA',
axeCoreVersion: '4.9.1',
experimentalRules: true,
bestPractices: true
}
};
Eine Erläuterung der Eigenschaften finden Sie unter ConfigurationOverrides Interface .
Fehler und Warnungen
Fehler
Nicht zulässiger Standard
Wenn Sie versuchen, einen nicht zulässigen Standard zu verwenden, erhalten Sie den Server-Antwortcode 422 (Nicht verarbeitbarer Inhalt). Beispielnachricht:
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"
Verwendung runOptions.runOnly
mit configurationOverrides
Wenn Sie beides runOptions.runOnly
mit configurationOverrides
verwenden, schlagen Ihre Tests sofort fehl. Nur verwenden configurationOverrides
.
Warnhinweise
Verwenden runOptions.runOnly
Wenn Sie in Ihrer Konfiguration runOptions.runOnly
verwenden, erhalten Sie diese Warnmeldung:
@axe-core/watcher
Ohne globale Konfigurationsunterstützung
Wenn Sie eine Version von @axe-core/watcher
verwenden, die zu alt ist, um globale Konfigurationsunterstützung zu bieten, erhalten Sie diese Meldung: