Mehrzeilige Strings in YAML: | und >, erklärt mit Live-Vorschau

Mehrzeilige Strings in YAML

Mehrzeilige Strings in YAML: | vs. > und Chomping mit - und + | We.Inc

Sieh genau, was die YAML-Blockstile | und > und die Chomping-Indikatoren -, clip und + erzeugen. Gib deinen eigenen Text ein und sieh zu, wie sich der resultierende String live aktualisiert.

YAML schreibt langen Text mit Block Scalars. Ein senkrechter Strich (|) behält jeden Zeilenumbruch genau so, wie er getippt wurde; ein Größer-als-Zeichen (>) faltet einzelne Zeilenumbrüche zu Leerzeichen. Ein Chomping-Indikator entscheidet dann über das Ende: - entfernt den letzten Zeilenumbruch, ohne Indikator bleibt einer erhalten, und + behält zusätzlich jede nachfolgende Leerzeile.

Die sechs Block-Scalar-Header und was sie erzeugen

Header
Zeilenumbrüche im Text
Ende des Strings

Bleiben erhalten
Ein Zeilenumbruch

Bleiben erhalten
Kein Zeilenumbruch

Bleiben erhalten
Zeilenumbruch plus jede nachfolgende Leerzeile

Einzelne Umbrüche werden zu Leerzeichen
Ein Zeilenumbruch

Einzelne Umbrüche werden zu Leerzeichen
Kein Zeilenumbruch

Einzelne Umbrüche werden zu Leerzeichen
Zeilenumbruch plus jede nachfolgende Leerzeile

Die Header-Zeile nach dem Schlüssel ist höchstens zwei Zeichen lang und entscheidet trotzdem, was dein Programm erhält. Wähle in der Vorschau einen Stil und einen Chomping-Indikator, tippe etwas Text, und der exakte String erscheint darunter in JSON-Notation, sodass jeder Zeilenumbruch als \n sichtbar ist.

Tippe oder füge den Text ein, den du speichern willst. Jede Zeile im Feld wird zu einer Inhaltszeile des Blocks.
Wähle literal (|) oder folded (>), dann strip (-), clip (Standard) oder keep (+).
Lege fest, wie viele Leerzeilen auf den Block folgen, um zu sehen, was keep mit ihnen macht.
Kopiere das YAML links. Rechts steht der String, den ein YAML-1.2-Parser an deinen Code übergibt.

Nutze |- für Werte, die als exakte Strings verglichen werden, etwa Tokens oder Zertifikate, die in eine Config eingefügt werden, damit sich kein verirrter Zeilenumbruch einschleicht.
Nutze > für langen Fließtext, der im Programm als ein Absatz gelesen werden, in der Datei aber schön umbrechen soll.
Shell-Schritte in CI-Dateien brauchen meist |, weil jeder Befehl auf seiner eigenen Zeile bleiben muss.
Rücke den Inhalt weiter ein als den Schlüssel. Die erste nicht leere Zeile legt die Einrückung für den ganzen Block fest.

Häufige Fragen

Was ist der Unterschied zwischen | und > in YAML?

Der senkrechte Strich beginnt einen Literal-Block: Jeder Zeilenumbruch, den du tippst, bleibt im Wert. Das Größer-als-Zeichen beginnt einen Folded-Block: Ein einzelner Umbruch zwischen zwei normalen Zeilen wird zu einem Leerzeichen, während Leerzeilen zu Zeilenumbrüchen werden.

Was bedeutet das Minuszeichen in |-?

Es ist der Chomping-Indikator strip. Der letzte Zeilenumbruch und alle Leerzeilen nach dem Text fallen weg, der Wert endet also beim letzten sichtbaren Zeichen.

Was bewirkt + nach | oder >?

Es ist der Indikator keep. Der letzte Zeilenumbruch und jede nachfolgende Leerzeile werden Teil des Werts. Ohne Indikator schneidet YAML ab (clip): Es behält einen abschließenden Zeilenumbruch und verwirft die Leerzeilen.

Warum werden manche Zeilen in meinem >-Block nicht gefaltet?

Zeilen, die mit zusätzlicher Einrückung beginnen, sind stärker eingerückte Zeilen. Das Falten verbindet sie nie, daher bleiben die Umbrüche um sie herum erhalten. So kannst du ein Codebeispiel oder eine Liste in gefaltetem Fließtext behalten.

Kann ich einen mehrzeiligen String ohne Block Scalars schreiben?

Ja. Ein String in doppelten Anführungszeichen darf \n-Escapes enthalten, und Scalars in Anführungszeichen oder ohne können sich über mehrere Zeilen erstrecken, wobei jeder einzelne Umbruch zu einem Leerzeichen gefaltet wird. Block Scalars sind leichter zu lesen, sobald Text lang wird.

Wie das Falten wirklich funktioniert

Das Falten verbindet nur zwei benachbarte Zeilen, die beide auf der Einrückung des Blocks beginnen. Ein Umbruch zwischen ihnen wird zu einem Leerzeichen. Lässt du eine Leerzeile, bekommt der Wert stattdessen einen einzelnen Zeilenumbruch, und so schreibst du Absätze.
Eine Zeile, die mit zusätzlichen Leerzeichen beginnt, bleibt unverändert, ebenso die Umbrüche auf beiden Seiten. Genau diese Regel wendet die Vorschau an, rücke also eine Zeile ein, um es zu beobachten.

Einrückungsindikatoren

Muss die erste Inhaltszeile mit Leerzeichen beginnen, kann YAML die Einrückung nicht erraten. Füge dem Header eine Ziffer hinzu, etwa |2, um anzugeben, um wie viele Leerzeichen der Block relativ zu seinem Elternelement eingerückt ist.
Ziffer und Chomping-Zeichen lassen sich in beliebiger Reihenfolge kombinieren, zum Beispiel |2- oder |-2.

Block Scalars in echten Dateien

Shell-Befehle in einem CI-Schritt

Der Literal-Stil hält jeden Befehl auf seiner eigenen Zeile, genau wie die Shell es braucht.

Eine lange Beschreibung, zu einem Absatz gefaltet

Gefaltet und gestrippt: Der Wert ist eine einzige Textzeile ohne Zeilenumbruch am Ende.

Nachfolgende Leerzeilen behalten

Mit + bleibt die Leerzeile nach dem Text im Wert, der geparste String endet also mit zwei Zeilenumbrüchen.

Vorschau für Block Scalars

Tippe den Text, wähle einen Stil und einen Chomping-Indikator und sieh das YAML, das du schreiben würdest, neben dem exakten String, den ein Parser zurückgibt.

Zu speichernder Text

Blockstil

Literal |

Folded >

Chomping-Indikator

Strip -

Clip (Standard)

Keep +

Leerzeilen nach dem Block

YAML

Resultierender String (JSON-Notation)

{n} Zeichen, {b} Zeilenumbrüche

Danke für deine Bestellung. Sie wird innerhalb von zwei Tagen verschickt. Fragen? Antworte einfach auf diese E-Mail. Bestellnummer: 10442

Mehrzeilige Strings in YAML: | und >, erklärt mit Live-Vorschau