YAML multiline strings: | en > uitgelegd met een live preview

YAML multiline strings

YAML multiline strings: | vs >, en chomping met - en + | We.Inc

Zie precies wat de blokstijlen | en > van YAML en de chomping-indicatoren -, clip en + opleveren. Typ uw eigen tekst en zie de string live bijwerken.

YAML schrijft lange tekst met block scalars. Een pipe (|) behoudt elke regeleinde precies zoals getypt; een groter-dan-teken (>) vouwt losse regeleinden om tot spaties. Een chomping-indicator bepaalt daarna het einde: - verwijdert de laatste newline, niets behoudt er één, en + behoudt ook elke afsluitende lege regel.

De zes block scalar-headers en wat ze opleveren

Header
Regeleinden binnenin
Einde van de string

Behouden
Eén newline

Behouden
Geen newline

Behouden
Newline plus elke afsluitende lege regel

Losse regeleinden worden spaties
Eén newline

Losse regeleinden worden spaties
Geen newline

Losse regeleinden worden spaties
Newline plus elke afsluitende lege regel

De headerregel na de sleutel is hooguit twee tekens, maar bepaalt wel wat uw programma ontvangt. Kies in de preview een stijl en een chomping-indicator, typ wat tekst, en de exacte string verschijnt eronder in JSON-notatie, zodat elke newline zichtbaar is als \n.

Typ of plak de tekst die u wilt opslaan. Elke regel in het vak wordt één inhoudsregel van het blok.
Kies literal (|) of folded (>), en daarna strip (-), clip (standaard) of keep (+).
Stel in hoeveel lege regels er na het blok komen om te zien wat keep ermee doet.
Kopieer de YAML links. Rechts staat de string die een YAML 1.2-parser aan uw code geeft.

Gebruik |- voor waarden die als exacte string worden vergeleken, zoals tokens of certificaten die in een config zijn geplakt, zodat er geen verdwaalde newline binnensluipt.
Gebruik > voor lange lopende tekst die in het programma als één alinea moet lezen maar in het bestand netjes moet afbreken.
Shell-stappen in CI-bestanden willen meestal |, omdat elk commando op een eigen regel moet blijven.
Spring de inhoud verder in dan de sleutel. De eerste niet-lege regel bepaalt de inspringing voor het hele blok.

Veelgestelde vragen

Wat is het verschil tussen | en > in YAML?

De pipe start een literal blok: elk regeleinde dat u typt, blijft in de waarde. Het groter-dan-teken start een folded blok: een los regeleinde tussen twee gewone regels wordt een spatie, terwijl lege regels newlines worden.

Wat betekent het minteken in |-?

Het is de chomping-indicator strip. Het laatste regeleinde en alle lege regels na de tekst vallen weg, dus de waarde eindigt bij het laatste zichtbare teken.

Wat doet + na | of >?

Het is de indicator keep. Het laatste regeleinde en elke afsluitende lege regel worden deel van de waarde. Zonder indicator doet YAML clip: het behoudt één laatste newline en laat de lege regels vallen.

Waarom worden sommige regels in mijn >-blok niet gevouwen?

Regels die met extra inspringing beginnen, zijn verder ingesprongen regels. Vouwen voegt die nooit samen, dus de regeleinden eromheen blijven behouden. Zo kunt u een codevoorbeeld of een lijst in gevouwen tekst houden.

Kan ik een string over meerdere regels schrijven zonder block scalars?

Ja. Een string tussen dubbele aanhalingstekens mag \n-escapes bevatten, en scalars met of zonder aanhalingstekens mogen over meerdere regels doorlopen, waarbij elk los regeleinde tot een spatie wordt gevouwen. Block scalars lezen makkelijker zodra tekst lang wordt.

Hoe vouwen echt werkt

Vouwen voegt alleen twee naburige regels samen die allebei op de eigen inspringing van het blok beginnen. Eén regeleinde ertussen wordt een spatie. Laat u één lege regel staan, dan krijgt de waarde in plaats daarvan één newline, en zo schrijft u alinea's.
Een regel die met extra spaties begint, blijft ongemoeid, en de regeleinden aan weerszijden ervan ook. Dat is de regel die de preview toepast, dus spring één regel in om het te zien gebeuren.

Inspringingsindicatoren

Als de eerste inhoudsregel met spaties moet beginnen, kan YAML de inspringing niet raden. Voeg een cijfer toe aan de header, zoals |2, om aan te geven hoeveel spaties het blok is ingesprongen ten opzichte van zijn ouder.
Het cijfer en het chomping-teken kunnen in elke volgorde worden gecombineerd, bijvoorbeeld |2- of |-2.

Block scalars in echte bestanden

Shell-commando's in een CI-stap

De literal-stijl houdt elk commando op een eigen regel, en dat is wat de shell nodig heeft.

Een lange beschrijving gevouwen tot één alinea

Gevouwen en gestript: de waarde is één regel tekst zonder newline aan het einde.

Afsluitende lege regels behouden

Met + blijft de lege regel na de tekst in de waarde, dus de geparste string eindigt op twee newlines.

Block scalar-preview

Typ de tekst, kies een stijl en een chomping-indicator, en zie de YAML die u zou schrijven naast de exacte string die een parser teruggeeft.

Tekst om op te slaan

Blokstijl

Literal |

Folded >

Chomping-indicator

Strip -

Clip (standaard)

Keep +

Lege regels na het blok

YAML

Resulterende string (JSON-notatie)

{n} tekens, {b} regeleinden

Bedankt voor uw bestelling. Die wordt binnen twee dagen verzonden. Vragen? Beantwoord deze e-mail. Bestelnummer: 10442

YAML multiline strings: | en > uitgelegd met een live preview