In diesem Artikel
Was ist YAML-Formatierung?
Die YAML-Formatierung vereinheitlicht Einrückung, Abstände und Struktur von YAML-Dokumenten. Gut formatiertes YAML lässt sich leichter lesen, überprüfen und pflegen — besonders wichtig, da YAML seine Struktur ausschließlich über die Einrückung und nicht über eckige oder geschweifte Klammern abbildet.
Ein YAML-Formatierer validiert außerdem die Syntax und erkennt Einrückungsfehler, fehlende Doppelpunkte und falsche Verschachtelungen, bevor sie zu Anwendungsfehlern führen. Diese Doppelrolle — Beautifier und Validator — macht ihn zu einem unverzichtbaren Werkzeug für alle, die mit Konfigurationsdateien arbeiten.
So funktioniert die YAML-Formatierung
Der Formatierer parst Ihr YAML-Dokument, validiert dessen Struktur und gibt eine einheitlich formatierte Version mit korrekter Einrückung aus.
- Einrückungsnormalisierung — vereinheitlicht das gesamte Dokument auf eine 2-Leerzeichen-Einrückung
- Syntaxvalidierung — prüft auf ungültige Zeichen, falsche Einrückung, doppelte Schlüssel und strukturelle Fehler
- Fehlerberichte — zeigt die genauen Zeilen- und Spaltennummern für jeden gefundenen Syntaxfehler an
Kostenlos testen – keine Registrierung erforderlich
YAML formatieren →Häufige YAML-Fehler
Die auf Leerraum angewiesene Syntax von YAML macht es anfällig für subtile Fehler, die visuell schwer zu erkennen sind.
- Tabulatorzeichen — YAML erlaubt zur Einrückung ausschließlich Leerzeichen; Tabulatoren führen zu Parse-Fehlern
- Uneinheitliche Einrückung — das Mischen von 2- und 4-Leerzeichen-Einrückung innerhalb desselben Dokuments
- Fehlende Doppelpunkte — den Doppelpunkt nach einem Schlüsselnamen zu vergessen ist ein häufiger Tippfehler
- Nicht in Anführungszeichen gesetzte Sonderwerte — Zeichenketten wie yes, no, on, off werden ohne Anführungszeichen als Boolesche Werte interpretiert
Wann YAML formatieren?
Formatieren Sie YAML immer dann, wenn Sie Konfigurationsdateien für Docker, Kubernetes, GitHub Actions oder eine beliebige CI/CD-Pipeline bearbeiten. Führen Sie den Formatierer aus, bevor Sie YAML-Änderungen committen, um Fehler frühzeitig zu erkennen. Bei bestehenden Konfigurationsdateien, deren Formatierung auseinandergedriftet ist, stellt der Formatierer die Einheitlichkeit wieder her.
Häufig gestellte Fragen
Ändert die Formatierung meine YAML-Werte?
Nein. Die Formatierung ändert nur Leerraum und Einrückung. Alle Schlüssel, Werte und die Datenstruktur bleiben identisch. Der Formatierer bewahrt die Zeichenketten-Anführungszeichen; Kommentare werden möglicherweise umorganisiert, ihr Inhalt bleibt jedoch erhalten.
Welche Einrückung verwendet der Formatierer?
Der Formatierer verwendet standardmäßig eine 2-Leerzeichen-Einrückung, die gängigste Konvention in YAML-Ökosystemen wie Kubernetes, Docker Compose und GitHub Actions.