YAML-Formatter

Vorher und nachher

Unordentliche Eingabe:

server:
  port:   8080
  hosts: ["api.example.com",  "api2.example.com"]
  timeout:  30
  debug: true

Formatiert (2 Leerzeichen, Block-Stil):

server:
  port: 8080
  hosts:
    - api.example.com
    - api2.example.com
  timeout: 30
  debug: true

Formatierungsoptionen

Regeln für Anführungszeichen

Minimal ist meistens genau richtig: Strings bleiben ohne Anführungszeichen, außer wenn das unsicher wäre. Der Formatter setzt automatisch Anführungszeichen bei:

• Legacy-Booleans als Strings: yes, no, on, off, y, n. YAML 1.2 liest sie bereits als Strings, aber viele Parser folgen noch YAML 1.1, wo ein no ohne Anführungszeichen zu false wird. Der Formatter setzt sie in der Ausgabe immer in Anführungszeichen, damit der berühmte Norwegen-Bug (NO in einer Länderliste als false gelesen) niemanden treffen kann, der Ihre Datei einliest.
• Zahlen als Strings: '007', '3.14'. Ohne Anführungszeichen würden sie als Ganzzahlen oder Gleitkommazahlen geparst.
• Strings mit Zeichen wie :, #, [, { oder führendem Leerraum, bei denen eine nackte Ausgabe die Struktur verändern würde.

Aufräumarbeiten bei jedem Lauf

• Leerzeichen am Zeilenende. Werden entfernt.
• Gemischte oder unregelmäßige Einrückung. Wird auf Ihre gewählte Einrückungsbreite normalisiert.
• Leerzeilen innerhalb von Sammlungen. Werden entfernt.
• Tabs in der Einrückung. YAML verbietet sie; der Parser weist die Eingabe mit einer klaren Fehlermeldung samt Zeilenangabe zurück, damit Sie den Fehler beheben können, statt eine Datei auszuliefern, die andere Parser ablehnen.

Kommentare, Anker und Merge-Keys

Das Formatieren normalisiert das Dokumentmodell, was Grenzen hat, die Sie vor dem Commit kennen sollten:

• Kommentare werden entfernt. Der Parser löst das Dokument in Daten auf, #-Kommentare überleben das Formatieren also nicht. Bewahren Sie eine Kopie auf, wenn Ihre Kommentare wichtig sind.
• Anker und Aliase werden aufgelöst. Über einen Alias geteilte Knoten bleiben geteilt, werden aber mit generierten Namen wie &ref_0 neu ausgegeben; die ursprünglichen Ankernamen bleiben nicht erhalten.
• Merge-Keys (<<:) werden aufgelöst und zu gewöhnlichen Mappings mit den zusammengeführten Werten.

Multi-Dokument-Streams

Streams mit mehreren Dokumenten werden unterstützt: Jedes Dokument wird unabhängig formatiert und mit dem Trennzeichen --- wieder zusammengefügt, bis zu 100 Dokumente pro Lauf.