Chaînes multilignes YAML : | et >, expliqués avec un aperçu en direct

Chaînes multilignes YAML

Chaînes multilignes YAML : | vs >, et le chomping - et + | We.Inc

Voyez exactement ce que produisent les styles de bloc | et > de YAML et les indicateurs de chomping -, clip et +. Saisissez votre propre texte et regardez la chaîne obtenue se mettre à jour en direct.

YAML écrit les longs textes avec des blocs scalaires. Une barre verticale (|) conserve chaque saut de ligne tel que saisi ; un signe supérieur (>) replie les sauts de ligne simples en espaces. Un indicateur de chomping décide ensuite de la fin : - supprime le saut de ligne final, l'absence d'indicateur en garde un, et + conserve aussi toutes les lignes vides finales.

Les six en-têtes de bloc scalaire et ce qu'ils produisent

En-tête
Sauts de ligne internes
Fin de la chaîne

Conservés
Un saut de ligne

Conservés
Aucun saut de ligne

Conservés
Saut de ligne plus toutes les lignes vides finales

Les sauts simples deviennent des espaces
Un saut de ligne

Les sauts simples deviennent des espaces
Aucun saut de ligne

Les sauts simples deviennent des espaces
Saut de ligne plus toutes les lignes vides finales

La ligne d'en-tête après la clé fait deux caractères au plus, et pourtant elle décide de ce que reçoit votre programme. Choisissez un style et un indicateur de chomping dans l'aperçu, saisissez du texte, et la chaîne exacte apparaît en dessous en notation JSON, pour que chaque saut de ligne soit visible sous forme de \n.

Saisissez ou collez le texte à stocker. Chaque ligne de la zone devient une ligne de contenu du bloc.
Choisissez littéral (|) ou plié (>), puis strip (-), clip (par défaut) ou keep (+).
Indiquez combien de lignes vides suivent le bloc pour voir ce que keep en fait.
Copiez le YAML à gauche. La partie droite est la chaîne qu'un parser YAML 1.2 transmet à votre code.

Utilisez |- pour les valeurs comparées comme chaînes exactes, par exemple des tokens ou des certificats collés dans une config, pour qu'aucun saut de ligne parasite ne s'y glisse.
Utilisez > pour une longue prose qui doit former un seul paragraphe dans le programme tout en restant bien découpée dans le fichier.
Les étapes shell des fichiers CI demandent généralement |, car chaque commande doit rester sur sa propre ligne.
Indentez le contenu plus loin que la clé. La première ligne non vide fixe l'indentation de tout le bloc.

Questions fréquentes

Quelle est la différence entre | et > en YAML ?

La barre verticale ouvre un bloc littéral : chaque saut de ligne saisi reste dans la valeur. Le signe supérieur ouvre un bloc plié : un saut simple entre deux lignes ordinaires devient un espace, tandis que les lignes vides deviennent des sauts de ligne.

Que signifie le signe moins dans |- ?

C'est l'indicateur de chomping strip. Le saut de ligne final et les éventuelles lignes vides après le texte sont supprimés : la valeur se termine au dernier caractère visible.

Que fait + après | ou > ?

C'est l'indicateur keep. Le saut de ligne final et toutes les lignes vides finales font partie de la valeur. Sans indicateur, YAML applique clip : il garde un saut de ligne final et supprime les lignes vides.

Pourquoi certaines lignes ne sont-elles pas repliées dans mon bloc > ?

Les lignes qui commencent par une indentation supplémentaire sont des lignes plus indentées. Le repli ne les joint jamais, donc les sauts qui les entourent sont conservés. Cela permet de garder un exemple de code ou une liste au milieu d'une prose repliée.

Puis-je écrire une chaîne multiligne sans bloc scalaire ?

Oui. Une chaîne entre guillemets doubles peut contenir des échappements \n, et les scalaires entre guillemets ou nus peuvent continuer sur plusieurs lignes, chaque saut simple se repliant en espace. Les blocs scalaires sont plus lisibles dès que le texte s'allonge.

Comment le repli fonctionne vraiment

Le repli ne joint que deux lignes voisines qui commencent toutes deux à l'indentation propre au bloc. Un saut entre elles devient un espace. Si vous laissez une ligne vide, la valeur reçoit à la place un seul saut de ligne : c'est ainsi qu'on écrit des paragraphes.
Une ligne qui commence par des espaces supplémentaires est laissée telle quelle, tout comme les sauts de part et d'autre. C'est la règle qu'applique l'aperçu : essayez d'indenter une ligne pour le constater.

Indicateurs d'indentation

Si la première ligne de contenu doit commencer par des espaces, YAML ne peut pas deviner l'indentation. Ajoutez un chiffre à l'en-tête, comme dans |2, pour indiquer de combien d'espaces le bloc est indenté par rapport à son parent.
Le chiffre et le signe de chomping peuvent se combiner dans n'importe quel ordre, par exemple |2- ou |-2.

Les blocs scalaires dans de vrais fichiers

Commandes shell dans une étape CI

Le style littéral garde chaque commande sur sa propre ligne, ce dont le shell a besoin.

Une longue description repliée en un seul paragraphe

Plié et strip : la valeur est une seule ligne de texte sans saut de ligne à la fin.

Conserver les lignes vides finales

Avec +, la ligne vide après le texte reste dans la valeur, donc la chaîne analysée se termine par deux sauts de ligne.

Aperçu des blocs scalaires

Saisissez le texte, choisissez un style et un indicateur de chomping, et voyez le YAML que vous écririez à côté de la chaîne exacte renvoyée par un parser.

Texte à stocker

Style de bloc

Littéral |

Plié >

Indicateur de chomping

Strip -

Clip (par défaut)

Keep +

Lignes vides après le bloc

YAML

Chaîne obtenue (notation JSON)

{n} caractères, {b} sauts de ligne

Merci pour votre commande. Elle sera expédiée sous deux jours. Des questions ? Répondez à cet e-mail. Réf. commande : 10442

Chaînes multilignes YAML : | et >, expliqués avec un aperçu en direct