Konfiguration

Jeder Runner nimmt dasselbe einfache engineOptions-Objekt entgegen — keine Konfigurationsdatei, die gepflegt werden muss, keine separaten CLI-Flags, die synchron gehalten werden müssen. Die CLI und alle Bindings bauen dieses Objekt aus ihren eigenen Flags oder Builder-Methoden für Sie auf, sodass alles, was Sie hier lernen, überall gilt, wo Sie einen Scan ausführen. Vier Dinge sollten Sie früh richtig einstellen:

Engine-Optionen

Beschränken Sie einen Scan auf genau die Regeln, die Sie wollen — durch Angabe einer WCAG-Version und -Stufe (WCAG 2.2 AA in einer Option, auf Wunsch Best Practices dazu), nach ID, nach Tag oder über ein benanntes Konformitätsprofil wie WCAG 2.2 AA oder Section 508 —, damit ein Lauf das meldet, wofür Sie tatsächlich verantwortlich sind, nicht mehr und nicht weniger. Die EN-301-549-Profile von core funktionieren weiterhin, sind aber veraltet: Dieser Standard kommt jetzt als Pack. Führen Sie nur einige Prüfungen aus und erhalten Sie trotzdem die WCAG-Kriterien, zu denen sie gehören, auf der Stufe, an der Sie gemessen werden, und lassen Sie sich vor dem Scan auflisten, was er melden wird. Nehmen Sie Widgets, die bekanntermaßen störende Befunde liefern, global oder für eine einzelne Regel vom Scan aus, ohne überall sonst Abdeckung zu verlieren, stellen Sie ein, wie streng die Kontrastprüfungen für einen menschlichen Auditor im Vergleich zu einem unbeaufsichtigten CI-Gate sein sollen, und ergänzen Sie eine organisationsspezifische Regel neben den eingebauten, wenn der Katalog etwas nicht abdeckt, das Ihnen wichtig ist, und geben Sie den Regeln das CSS eines Stylesheets von einem anderen Origin, das die Seite nicht lesen kann. Die vollständige Referenz finden Sie unter Engine-Optionen.

Packs

Prüfen Sie gegen mehr als WCAG, ohne die Engine zu forken. Ein Pack bringt einen nationalen Standard, die Barrierefreiheitsrichtlinie Ihrer Organisation oder ein paar hauseigene Regeln aus einem eigenen Paket mit, und die Engine führt es aus wie ihre eigenen Regeln: Seine Profile wählen aus, was läuft, seine Checklistenpunkte kommen jeweils als ein Ergebnis zurück, und jeder Bericht zeigt sie neben den WCAG-Kriterien. Dasselbe Pack funktioniert aus Node, in jedem Binding, mit den Test-Matchern und in der CLI, und npx surea11y-pack new erzeugt eines, das seine eigenen Tests direkt nach dem Erzeugen besteht. Eine Norm kann die Befunde einer Regel den Anforderungen zuordnen, zu denen sie gehören, und eine Pack-Regel kann einer Person sagen, wie sie beantwortet, was die Regel offen lässt. Unter Packs erfahren Sie, wie Sie eines verwenden oder schreiben.

CI-Integration

Bringen Sie ein funktionierendes Barrierefreiheits-Gate in Ihre Pipeline, ohne es von Grund auf zu schreiben: Vorlagen für GitHub Actions und Bitbucket Pipelines zum direkten Einfügen steuern einen Build über den Exit-Code der CLI, nehmen die bereits vorhandenen Verstöße einer bestehenden Website in eine Baseline auf, sodass nur tatsächlich neue zum Fehlschlag führen, und laden SARIF-Ergebnisse direkt in GitHub Code Scanning hoch, wo Ihr Team ohnehin hinschaut. Rezepte für GitLab CI und Azure DevOps bringen die Ergebnisse als JUnit in deren eigene Testansichten, von der CLI im selben Schritt geschrieben, und ein JUnit-Bericht kann offene Befunde, die zu fail tendieren, zu Fehlschlägen machen, damit ein wahrscheinlicher Fehlschlag nicht als übersprungener Test durchgeht. Die vollständigen Vorlagen finden Sie unter CI-Integration.

Locales

Liefern Sie Befunde, mit denen Ihr Team tatsächlich arbeiten kann, in der Sprache, die es am schnellsten liest — jeder Regeltitel sowie Zusammenfassung und Hinweis jedes Vorkommens werden aus einem schlüsselbasierten Wörterbuch aufgelöst, mit einem Fallback auf Englisch pro String statt einer Leerstelle oder eines Fehlers. Heute sind fünf Sprachen verfügbar (Englisch, Französisch, Deutsch, Spanisch, Japanisch), und ein Ergebnis gibt immer genau an, welche Locale verwendet wurde, sodass nichts unbemerkt schlechter wird. Die Schritte, mit denen sich ein offener Befund beantworten lässt („So prüfen Sie es“), gibt es in denselben fünf Sprachen. Abdeckung und wie Sie ein eigenes Wörterbuch bereitstellen, finden Sie unter Locales.