Was prüft der YAML-Prüfer?

YAML ist das Format vieler Konfigurationsdateien: Docker-Compose-Dateien, Kubernetes-Manifeste, GitHub-Actions- und GitLab-CI-Workflows, Ansible-Playbooks, OpenAPI-Spezifikationen und die Einstellungen unzähliger Anwendungen. Da Einrückungen in YAML eine Bedeutung haben, kann eine fehlende Leerstelle, ein versehentlicher Tabulator oder ein wiederholter Schlüssel eine Datei auf schwer erkennbare Weise beschädigen. Der Prüfer liest dein YAML wie ein Parser und listet jedes Problem mit Zeile und Spalte auf.

So verwendest du das Tool

  1. Füge YAML in den Editor ein oder gib es dort ein.
  2. Das Ergebnis erscheint während der Eingabe: Entweder ist das YAML gültig und die Anzahl der enthaltenen Dokumente wird angezeigt, oder alle Probleme werden in der Reihenfolge ihres Auftretens im Text aufgelistet.
  3. Jedes Problem wird im Editor markiert: Fehler rot, Warnungen gelb. Klicke auf ein Problem, um im Editor dorthin zu springen, oder auf eine Markierung, um das Problem in der Liste zu finden.

Was das Tool erkennt

  • Syntaxfehler: nicht geschlossene Anführungszeichen und Klammern, Elemente mit zu geringer oder zu großer Einrückung, ein Schlüssel und ein Listenelement auf derselben Ebene sowie verschachtelte Zuordnungen in einer Zeile wie a: b: c.
  • Wiederholte Schlüssel: derselbe Schlüssel zweimal in einer Zuordnung. Die meisten Parser würden stillschweigend nur einen der Werte beibehalten, sodass die andere Einstellung verloren geht.
  • Tabulatoren zur Einrückung: YAML erlaubt für Einrückungen nur Leerzeichen.
  • Aliase ohne Anker: Für einen *name-Alias ist ein &name-Anker erforderlich, der zuvor im selben Dokument vorkommt.
  • Warnungen bei Inhalten, die zwar geparst werden können, aber möglicherweise nicht wie beabsichtigt funktionieren, etwa bei einem dem Parser unbekannten Tag oder einer nicht unterstützten %YAML-Version.

Derselbe Schlüssel in verschiedenen Zuordnungen ist zulässig. Auch eine Datei mit mehreren durch --- getrennten Dokumenten ist kein Problem: Die Zeilen werden für die gesamte Datei gezählt.

Was das Tool nicht prüft

Der Prüfer kontrolliert, ob der Text gültiges YAML ist, nicht, ob ein bestimmtes Programm ihn akzeptiert. Eine Docker-Compose-Datei kann gültiges YAML enthalten und trotzdem eine Einstellung benennen, die Docker Compose nicht kennt. Die Meldungen stammen aus der yaml-Bibliothek und sind auf Englisch.

So funktioniert es

Das Tool parst den Text mit der yaml-Bibliothek, die der YAML-1.2-Spezifikation folgt und eindeutige Schlüssel voraussetzt. Alles läuft in deinem Browser: Deine Dateien werden niemals hochgeladen.

Funktionen

  • Syntaxfehler mit Zeile und Spalte
  • Wiederholte Schlüssel, Tabulatoren zur Einrückung und Aliase ohne Anker
  • Fehler und Warnungen im Editor markiert, mit Klick zum entsprechenden Textabschnitt
  • Dateien mit mehreren Dokumenten
  • Läuft in deinem Browser