YAML Validator: YAML beim Tippen prüfen
Füge dein YAML ein, und der YAML Validator prüft es schon beim Tippen. Jeder Syntaxfehler wird in einfachen Worten erklärt, mit Zeile und Spalte. Er findet Tabs als Einrückung, doppelte Schlüssel, offene Anführungszeichen und Klammern sowie unsichtbare geschützte Leerzeichen, die wie Einrückung aussehen. Dein YAML wird in deinem Browser geprüft und nie hochgeladen.
YAML prüfen: so benutzt du den Validator
Füge dein YAML in das Feld YAML ein oder tippe es dort. Eine Schaltfläche zum Prüfen gibt es nicht, denn der Text wird live geprüft.
- Eingefügter Text wird sofort geprüft. Beim Tippen läuft die Prüfung etwa eine Viertelsekunde nach deiner letzten Taste, bei sehr großem Text etwas später. Bis das neue Ergebnis da ist, bleibt das alte abgeblendet stehen.
- Lies das Feld unter dem Editor. Ein grünes Feld Gültiges YAML heißt: Die Syntax stimmt. Ein rotes Feld Ungültiges YAML (oder „Ungültiges YAML: N Probleme“) listet auf, was falsch ist.
- Jedes Problem nennt einen Satz, „Zeile N, Spalte M“ und einen Ausschnitt der Zeile mit Zeilennummern: zwei Zeilen darüber, eine darunter und ein ^ unter der Spalte.
- Drücke Im Editor anzeigen, um die Zeile im Feld auszuwählen. Behebe sie und sieh zu, wie das Feld grün wird.
Pro Dokument wird nur der erste Syntaxfehler gemeldet. Die Fehler danach sind meist Folgen, etwa wenn ein fehlendes Anführungszeichen die Zeilen darunter verschluckt. Doppelte Schlüssel und nicht definierte Aliase werden immer vollständig aufgelistet. Angezeigt werden bis zu 20 Probleme.
YAML Fehler finden und beheben
Jeder Fehler wird in einem Satz erklärt statt als rohe Parser-Meldung. Das sind die häufigsten:
- Die Zeile ist mit einem Tab eingerückt. Ein Editor hat einen Tab eingefügt, oder er kam beim Einfügen mit. Ersetze den Tab durch Leerzeichen.
- Die Zeile steht nicht bündig mit den anderen Schlüsseln ihres Mappings. Ein Schlüssel hat ein Leerzeichen mehr oder weniger als seine Nachbarn. Gib Schlüsseln auf derselben Ebene dieselbe Einrückung.
- Die Einrückung stimmt nicht. Ein verschachtelter Block ist nicht tiefer eingerückt als sein übergeordneter Schlüssel. Rücke das Kind weiter ein.
- Ein Schlüssel kommt mehrfach im selben Mapping vor. Meist hat ein kopierter Block ihn doppelt hinterlassen. Führe die Einträge zusammen oder lösche den doppelten.
- Die Zeile ist kein Schlüssel-Wert-Paar. Es fehlt ein Doppelpunkt, oder eine umgebrochene Zeile ist nicht eingerückt. Ergänze
:nach dem Schlüssel oder rücke die Fortsetzung ein. - Ein Paar steht in einem anderen Paar derselben Zeile. Ursache ist meist ein zweiter Doppelpunkt in einem einfachen Wert, wie in
a: b: c. Setze den Wert in Anführungszeichen oder nimm eine neue eingerückte Zeile. - Eine Klammer wird nie geschlossen, oder ein Anführungszeichen nie beendet. Die Meldung zeigt auf die Zeile, in der sie geöffnet wurde. Ergänze das schließende Zeichen.
- Zwischen Einträgen in
[ ]oder{ }fehlt ein Komma. Zwei Einträge laufen ineinander. Ergänze das Komma. - Ein Wert beginnt mit
@oder einem Backtick. Setze ihn in Anführungszeichen. - Ein
#klebt am Wort davor. Ein Kommentar beginnt nur nach einem Leerzeichen. Ergänze es oder setze den Text in Anführungszeichen. \qist keine gültige Escape-Sequenz in doppelten Anführungszeichen. Das passiert oft bei Windows-Pfaden. Schreibe\\oder nimm einfache Anführungszeichen.- Ein Alias zeigt auf einen Anker, der weiter oben fehlt. Definiere
&nameweiter oben in der Datei. - Ein Teil passt nicht an die Stelle. Oft sind Listeneinträge mit
-und Zeilen wiekey: valueauf derselben Ebene vermischt, oder die Zeile darüber ist unfertig. Setze die Liste unter einen eigenen Schlüssel und prüfe die Zeile darüber. - Eine
%-Direktive am Anfang ist ungültig oder wird nicht unterstützt. Entferne sie oder nutze%YAMLbzw.%TAGrichtig.
Was Fehlermeldungen anderer Parser bedeuten
Du kommst von einer Fehlermeldung im Terminal oder im CI-Log? So entsprechen die gängigen Formulierungen dem, was der Validator meldet. Füge dieselbe Datei ein, und er zeigt dir die Zeile.
found character that cannot start any token while scanning for the next token: ein Tab am Zeilenanfang oder ein Wert, der mit@oder einem Backtick beginnt.tabs are not allowed for indent: ein Tab als Einrückung.mapping values are not allowed here: ein zweiter Doppelpunkt in einer Zeile, etwaa: b: c, ein Wert ohne Anführungszeichen, der:enthält, oder eine Zeile unter einem Schlüssel, der schon einen Wert hat.did not find expected key: eine Zeile, die nicht bündig mit den anderen Schlüsseln ihres Mappings steht.bad indentation of a mapping entry: ein Schlüssel mit falscher Einrücktiefe.could not find expected ':': eine Zeile ohne Doppelpunkt nach dem Schlüssel.
Die Formulierungen unterscheiden sich je nach Parser (PyYAML, js-yaml, Ruby, Go, die Loader von Home Assistant und ESPHome). Ein Parser meldet außerdem oft eine Zeile unterhalb des eigentlichen Fehlers. Der Validator zeigt auf die Zeile, die er dir zeigen kann.
YAML-Datei prüfen: Tabs und unsichtbare Zeichen
Die zwei schwersten YAML-Fehler sind die, die du nicht siehst. Der Validator macht sie sichtbar.
- Ein Tab im Ausschnitt wird als Pfeil gezeichnet, ein geschütztes Leerzeichen oder ein Zeichen ohne Breite als Punkt.
- Enthält die Fehlerzeile ein unsichtbares Zeichen, nennt eine Extrazeile es mit Codepunkt, zum Beispiel
U+00A0, und Spalte. Erfasst werden geschützte Leerzeichen, Zeichen ohne Breite, eine Byte-Order-Mark und Leerzeichen in Vollbreite. - Ist die Datei gültig, aber eine Zeile beginnt mit einem unsichtbaren Leerzeichen, erscheint unter dem grünen Feld ein gelbes Feld Gültig, aber sieh dir diese Zeile an. YAML liest das Zeichen als Teil des Schlüssels, die Zeile ist also gar nicht eingerückt. Meist stammt es aus Text, den du von einer Webseite, einem Wiki oder einer Chat-App kopiert hast.
Ein Beispiel: In einer Datei mit server: und darunter port: 8080 beginnt die letzte Zeile host: example.com mit zwei geschützten Leerzeichen statt zwei Leerzeichen. YAML liest sie als eigenen Schlüssel der obersten Ebene, und host gehört nicht zu server. Das gelbe Feld nennt das Zeichen und die Zeile.
YAML formatieren und kopieren
Schalte oberhalb des Feldes den Schalter YAML formatieren ein. Er ist standardmäßig aus. Ist der Text gültig, erscheint ein Block Formatiertes YAML mit einer Schaltfläche Kopieren, die nach dem Kopieren zu Kopiert wechselt. Das Formatieren folgt festen Regeln:
- Die Einrückung beträgt 2 Leerzeichen. Eine andere Breite gibt es nicht, und Listen unter einem Schlüssel werden eingerückt.
- Kommentare, Anker, Aliase, Anführungszeichen-Stile und die Reihenfolge der Schlüssel bleiben erhalten.
- Lange Zeilen werden nie umgebrochen.
- Mehrere Dokumente behalten ihre
----Trenner.
Formatiert wird nur gültiges YAML. Eine kaputte Datei lässt sich so nicht reparieren: Behebe zuerst die Fehler. Sehr lange Ausgaben werden nach 600.000 Zeichen abgeschnitten angezeigt, Kopieren kopiert trotzdem alles.
YAML Linter online: Anwendungen, Größe und Grenzen
Die Prüfung ist immer dieselbe, egal wofür das YAML gedacht ist. Du kannst damit GitHub-Actions-Workflows, docker-compose.yml, Kubernetes-Manifeste und Helm-Werte, OpenAPI-Dateien, Ansible-Playbooks, die Konfiguration von Home Assistant, CloudFormation-Vorlagen und mkdocs-Konfigurationen prüfen. Füge die Datei vor dem Commit ein, und die Syntaxfehler erscheinen, ohne auf einen CI-Lauf zu warten. Eine Datei mit mehreren Dokumenten, getrennt durch ---, wird Dokument für Dokument geprüft, und das grüne Feld nennt die Anzahl. Anker (&name) und Aliase (*name) werden geprüft. Eigene Tags wie !Ref, !Sub und !GetAtt von CloudFormation oder !reference von GitLab gelten als gültig.
Die Prüfung läuft in einem Web Worker in deinem Browser. Übliche Konfigurations-, CI- und Kubernetes-Dateien sind im Nu geprüft. Die Grenze liegt bei 5.000.000 Zeichen, und ein Text nahe daran braucht ein paar Sekunden und viel Speicher. Darüber wirst du gebeten, ein kleineres Stück einzufügen.
Geprüft wird nur die YAML-Syntax. Der Validator weiß nicht, was ein bestimmtes Werkzeug erwartet: Kubernetes-Felder, Schlüssel von GitHub Actions oder Docker Compose und JSON-Schema-Regeln werden nicht geprüft, und ein falsch geschriebener Schlüssel besteht trotzdem. Er folgt YAML 1.2, also sind die Wörter yes, no, on und off der Version 1.1 einfacher Text und werden nie beurteilt. Er führt nichts aus, lädt nichts und behandelt ein einzelnes altes Mac-Zeilenende (CR) nicht als Zeilenumbruch.
Arbeitest du mit anderen Formaten? Räume JSON mit dem JSON formatieren auf, prüfe es mit dem JSON-Schema-Validator gegen ein Schema oder prüfe Markup mit dem XML-Validator. Suchst du ein Muster in deiner Konfiguration? Probiere es im Regex-Tester aus.
Häufige Fragen
Wie kann ich YAML validieren?
Füge dein YAML in das Feld „YAML“ ein. Der Text wird beim Einfügen und Tippen geprüft, es gibt also keine Schaltfläche zum Drücken. Ein grünes Feld „Gültiges YAML“ bedeutet, dass die Syntax stimmt. Ein rotes Feld „Ungültiges YAML“ nennt jedes Problem in einfachen Worten mit Zeile und Spalte und einem Ausschnitt der Zeile.
Warum sagt YAML, dass Tabs zur Einrückung nicht erlaubt sind?
YAML erlaubt zum Einrücken nur Leerzeichen, und ein Tab am Zeilenanfang ist ein Syntaxfehler. Editoren fügen oft Tabs ein, wenn du die Tab-Taste drückst, oder ein Tab kommt beim Einfügen aus einer anderen Quelle mit. Der Validator zeigt die Zeile mit der Meldung, dass sie mit einem Tab eingerückt ist. Ersetze den Tab durch Leerzeichen.
Was bedeutet „mapping values are not allowed here“ in YAML?
Meist steht in einer Zeile ein zweiter Doppelpunkt, etwa bei „a: b: c“, oder ein Wert ohne Anführungszeichen enthält einen Doppelpunkt. Es kann auch eine Zeile unter einem Schlüssel stehen, der schon einen Wert hat. Setze den Wert in Anführungszeichen oder schreibe das innere Paar in eine eigene eingerückte Zeile.
Was bedeutet „did not find expected key“ in YAML?
Eine Zeile steht nicht bündig mit den anderen Schlüsseln ihres Mappings. Meist hat ein Schlüssel ein Leerzeichen mehr oder weniger als seine Nachbarn. Gib allen Schlüsseln auf derselben Ebene dieselbe Einrückung. Der Validator meldet dazu, dass die Zeile nicht mit den anderen Schlüsseln bündig ist.
Wie finde ich doppelte Schlüssel in YAML?
Füge den Text ein. Doppelte Schlüssel im selben Mapping werden immer alle aufgelistet, jeder mit Zeile und Spalte. Meist hat ein kopierter Block einen Schlüssel doppelt hinterlassen. Führe die Einträge zusammen oder lösche den doppelten.
Warum zeigt eine gültige YAML-Datei „Gültig, aber sieh dir diese Zeile an“?
Eine Zeile beginnt mit einem unsichtbaren Leerzeichen, zum Beispiel einem geschützten Leerzeichen. YAML liest es als Teil des Schlüssels, deshalb ist die Zeile nicht wirklich eingerückt, auch wenn die Datei gültig ist. Das gelbe Feld nennt das Zeichen und die Zeile. Lösche es und tippe normale Leerzeichen.
Kann ich eine YAML-Datei für GitHub Actions, Docker Compose oder Kubernetes prüfen?
Ja, die Syntaxprüfung ist für jedes YAML dieselbe. Sie funktioniert für Workflows, docker-compose.yml, Kubernetes-Manifeste und viele weitere Dateien. Geprüft wird nur die Syntax: Welche Schlüssel ein Werkzeug erwartet, prüft der Validator nicht, und ein falsch geschriebener Schlüsselname besteht trotzdem.
Wie groß darf eine YAML-Datei zum Prüfen sein?
Die Grenze liegt bei 5.000.000 Zeichen. Übliche Konfigurationsdateien sind im Nu geprüft, ein Text nahe der Grenze braucht ein paar Sekunden und viel Speicher. Ist der Text länger, wirst du gebeten, ein kleineres Stück einzufügen.
Empfohlen
-
Yubico Security Key C NFCSchütze das GitHub- oder Cloud-Konto, in das du diese Konfiguration pushst.
-
Elgato Stream Deck Neo (8 Tasten)Eine Taste für deine Lint-, Commit- und Deploy-Befehle.
-
Govee Smart Light BarsSanftes Licht hinter dem Bildschirm für nächtliche Pipeline-Fixes.
Hilft, die Tools kostenlos zu halten. ✨
Symbolbilder. Als Amazon-Partner verdiene ich an qualifizierten Verkäufen.