Tools
YAML Formatter
Der YAML Formatter bringt Ordnung in YAML-Konfigurationsdateien und -Dokumente. Inkonsistente Einrückungen, fehlende Zeilenumbrüche und Syntaxfehler werden automatisch erkannt und korrigiert. Mit Syntaxhervorhebung, Zeilennummern und Strukturstatistiken ist das Tool die ideale Hilfe für DevOps-Engineers, Entwickler und alle, die täglich mit YAML-Konfigurationen wie Kubernetes-Manifesten, GitHub-Actions oder Docker-Compose-Dateien arbeiten.
Was ist der YAML Formatter?
YAML (YAML Ain't Markup Language) ist ein menschenlesbares Datenformat, das in der DevOps-Welt allgegenwärtig ist: Kubernetes-Manifeste, GitHub-Actions-Workflows, Docker-Compose-Dateien, Ansible-Playbooks und viele Konfigurationsdateien verwenden YAML. Die Einrückungs-basierte Syntax von YAML ist intuitiv, aber fehleranfällig – ein falsch eingerücktes Feld kann den gesamten Prozess zum Absturz bringen. Der YAML Formatter parst das Dokument und gibt es mit korrekter, konsistenter Einrückung aus.
Wie funktioniert das Tool?
Das Tool nutzt einen clientseitigen YAML-Parser, um den eingegebenen Text zu parsen und auf Syntaxfehler zu prüfen. Bei korrektem YAML wird das geparste Dokument mit einer einheitlichen Einrückung (2 oder 4 Leerzeichen) re-serialisiert. Strings, Zahlen, Booleans, Null-Werte, Arrays und Objekte werden unterschiedlich eingefärbt. Syntaxfehler werden mit der genauen Zeilen- und Spaltenangabe gemeldet. Strukturstatistiken zeigen Anzahl der Schlüssel, Arrays, Verschachtelungstiefe und Gesamtzeilen.
Typische Anwendungsfälle
- Korrigieren der Einrückung in Kubernetes-YAML-Manifesten nach manuellem Bearbeiten
- Validieren eines GitHub-Actions-Workflow-Files vor dem Commit
- Lesbarmachen kompakter oder schlecht formatierter YAML-API-Antworten
- Prüfen ob eine Docker-Compose-Datei YAML-syntaktisch korrekt ist
Schritt-für-Schritt-Anleitung
- Schritt 1: Füge dein YAML-Dokument in das Eingabefeld ein oder lade eine YAML-Datei hoch.
- Schritt 2: Wähle die gewünschte Einrückungstiefe (2 oder 4 Leerzeichen).
- Schritt 3: Prüfe eventuelle Fehlermeldungen und korrigiere die Syntax.
- Schritt 4: Kopiere das formatierte YAML oder lade es als Datei herunter.
Beispiel
Eingabe
name: Max age: 30 city: Berlin
Ausgabe
name: Max age: 30 city: Berlin
Tipps & Hinweise
- YAML verwendet ausschließlich Leerzeichen für Einrückung – Tabs sind verboten und führen zu Syntaxfehlern. Konfiguriere deinen Editor, um Tabs automatisch in Leerzeichen umzuwandeln.
- Boolesche Werte in YAML sind: true, false, yes, no, on, off (YAML 1.1). In YAML 1.2 gelten nur true und false als Boolean – wichtig für Kubernetes, das einen strikten Parser verwendet.
- Mehrzeilige Strings können mit | (Block-Scalar, Zeilenumbrüche erhalten) oder > (Folded-Scalar, Zeilenumbrüche werden zu Leerzeichen) geschrieben werden.
Häufige Fragen
Warum schlägt meine YAML-Datei in Kubernetes fehl, obwohl der Formatter keine Fehler zeigt?
Kubernetes validiert YAML auf zwei Ebenen: Erstens die syntaktische Korrektheit (YAML-Wohlgeformtheit) und zweitens die semantische Korrektheit gegen das Kubernetes-API-Schema. Der Formatter prüft nur die Syntax; semantische Fehler wie falsche Feldnamen oder ungültige Werte werden nicht erkannt.
Was ist der Unterschied zwischen YAML und JSON?
YAML ist eine Obermenge von JSON – jedes gültige JSON-Dokument ist auch gültiges YAML. YAML erlaubt Kommentare (mit #), ist einrückungsbasiert und hat kompaktere Syntax für einfache Werte. JSON ist maschinenfreundlicher und einfacher zu parsen; YAML ist menschenfreundlicher für Konfigurationsdateien.
Kann ich YAML-Anker und -Aliase im Formatter verwenden?
Ja, der Formatter unterstützt YAML-Anker (&anchor) und Aliase (*alias), die für die Wiederverwendung von Werten innerhalb eines YAML-Dokuments verwendet werden. Diese werden korrekt geparst und ausgegeben.
YAML Formatter
Formatiere und verschönere YAML-Dokumente mit Syntaxhervorhebung, Zeilennummern, Einrückungskorrektur und Strukturstatistiken.
Tool öffnen