YAML-Dokumente hübsch drucken, validieren und untersuchen mit optionaler Schlüsselsortierung und Anker/Alias-Erweiterungssteuerung.
YAML-Dokumente hübsch drucken, validieren und untersuchen mit optionaler Schlüsselsortierung und Anker/Alias-Erweiterungssteuerung. YAML-Dokumente hübsch drucken, validieren und untersuchen mit optionaler Schlüsselsortierung und Anker/Alias-Erweiterungssteuerung.
Array
Hintergrund
Was YAML ist und was einen Viewer nützlich macht
YAML („YAML Ain't Markup Language") ist ein menschenfreundliches
Datenserialisierungsformat, das weithin für Konfigurationsdateien
verwendet wird (docker-compose.yml, Kubernetes-Manifests, GitHub
Actions-Workflows, Ansible-Playbooks usw.). Es tauscht die Strenge von
JSON gegen ein einrückungsbasiertes Strukturmodell und ein reicheres
Typsystem, das Daten, Mehrzeilenzeichenketten und Referenzen umfasst.
Weil YAML auf Einrückung beruht, um Verschachtelung auszudrücken, kann
eine fehlende Leerstelle die Bedeutung eines gesamten Dokuments ändern,
und die meisten Editoren heben die Hierarchie nicht visuell hervor. Ein
Viewer parst das Dokument und gibt es mit konsistenter Einrückung neu
aus und deckt dabei Einrückungsfehler auf, während er die Struktur
sichtbar macht.
Funktionen, die sich lohnen
Die meisten Viewer lassen dich einige Verhaltensweisen umschalten:
Schlüssel alphabetisch für stabile Diffs sortieren, YAML-Anker und
-Aliase (die & / *-Syntax) erweitern oder entfernen, und die
Einrückungsbreite wählen. Die Sortieroption ist besonders wertvoll beim
Vergleich zweier Schnappschüsse derselben Konfiguration – ohne sie kann
das Umordnen von Schlüsseln zwischen Releases echte Änderungen maskieren.
Die Byte- und Top-Level-Schlüssel-Statistik hilft dir zu sehen, wie
schwer das Dokument ist und wo der Großteil liegt. Wenn du wissen musst,
ob dein YAML in ein Limit für Umgebungsvariablen oder ein
Kubernetes-ConfigMap-Größenbudget passt, steht diese Zahl direkt da.
Workflow-Tipps
Wenn du einen Parse-Fehler debuggst, kopiere das Dokument in einen
frischen Viewer-Tab und schalte die Optionen nacheinander um: eine
&anchor-Syntax sieht vielleicht wie ein Tippfehler aus, bis du sie
erweitert siehst. Für sehr lange Pipelines verwende eine
4-Leerzeichen-Einrückung, um gängigen Styleguides zu entsprechen; für
Inline-Review oder Chat-Einfügungen ist 2-Leerzeichen kompakter. Bewahre
beim Committen von Konfiguration immer die ursprüngliche
Dokumentstruktur: Ein Viewer dient der Inspektion, nicht der
Normalisierung.
Häufig gestellte Fragen
Warum sieht YAML aus wie JSON mit Extraschritten?
JSON ist eine strikte Teilmenge von YAML 1.2: jedes JSON-Dokument ist ein gültiges YAML-Dokument. YAML fügt Kommentare, Mehrzeilenzeichenketten, Referenzen und ein reicheres Typsystem oben darauf.
Was ist der Unterschied zwischen Ankern (&) und Aliasen (*)?
Ein Anker (`&name value`) markiert einen Wert mit einem Namen; ein Alias (`*name`) verwendet diesen Wert an anderer Stelle erneut. Der Viewer kann Aliase inline erweitern (`*name` wird zum ursprünglichen Wert) oder sie entfernen, was nützlich ist, um die Ausgabe vor dem Commit zu normalisieren.
Behält der Viewer Kommentare beim Neu-Ausgeben bei?
Nein. Die meisten YAML-Bibliotheken (einschließlich js-yaml) entfernen Kommentare während eines Load/Dump-Durchlaufs, weil das Datenmodell von YAML sie nicht enthält. Wenn Kommentare wichtig sind, bearbeite die Originaldatei direkt.
Warum meldet der Viewer, er könne kein Tab-Zeichen finden?
YAML erlaubt keine Tabs für Einrückung – nur Leerzeichen. Selbst ein einzelnes Tab innerhalb eines Block-Skalars kann manche Parser verwirren. Ersetze Tabs durch Leerzeichen und versuche es erneut.
Führt der Viewer mehrteilige YAML-Dateien zusammen?
Er parst und gibt jedes Dokument separat neu aus, aber der aktuelle Viewer gibt jeweils nur ein einzelnes Dokument aus. Verwende für diese Dateien einen Multi-Doc-Editor.
Wird mein YAML hochgeladen?
Nein. Das Parsen und Reformattieren geschieht lokal über die gebündelte js-yaml-Bibliothek; nichts verlässt den Browser.