Strings multilinha em YAML: | e >, explicados com prévia ao vivo

Strings multilinha em YAML

Strings multilinha em YAML: | vs >, e o chomping - e + | We.Inc

Veja exatamente o que os estilos de bloco | e > do YAML e os indicadores de chomping -, clip e + produzem. Digite seu próprio texto e veja a string resultante se atualizar ao vivo.

O YAML escreve textos longos com block scalars. Uma barra vertical (|) mantém cada quebra de linha exatamente como foi digitada; um sinal de maior que (>) transforma quebras de linha simples em espaços. Depois, um indicador de chomping decide o final: - remove a última quebra de linha, nenhum indicador mantém uma, e + mantém também todas as linhas em branco do final.

Os seis cabeçalhos de block scalar e o que produzem

Cabeçalho
Quebras de linha no meio
Final da string

Mantidas
Uma quebra de linha

Mantidas
Nenhuma quebra de linha

Mantidas
Quebra de linha mais todas as linhas em branco do final

Quebras simples viram espaços
Uma quebra de linha

Quebras simples viram espaços
Nenhuma quebra de linha

Quebras simples viram espaços
Quebra de linha mais todas as linhas em branco do final

A linha de cabeçalho depois da chave tem no máximo dois caracteres, mas decide o que o seu programa recebe. Escolha um estilo e um indicador de chomping na prévia, digite um texto, e a string exata aparece abaixo em notação JSON, para que cada quebra de linha fique visível como \n.

Digite ou cole o texto que você quer guardar. Cada linha da caixa vira uma linha de conteúdo do bloco.
Escolha literal (|) ou folded (>), depois strip (-), clip (padrão) ou keep (+).
Defina quantas linhas em branco vêm depois do bloco para ver o que o keep faz com elas.
Copie o YAML da esquerda. O lado direito é a string que um parser YAML 1.2 entrega ao seu código.

Use |- para valores comparados como strings exatas, como tokens ou certificados colados na config, para que nenhuma quebra de linha perdida entre de fininho.
Use > para textos longos que devem ser lidos como um único parágrafo no programa, mas quebrar bem no arquivo.
Etapas de shell em arquivos de CI geralmente pedem |, porque cada comando precisa ficar na própria linha.
Indente o conteúdo mais do que a chave. A primeira linha não vazia define a indentação do bloco inteiro.

Perguntas frequentes

Qual é a diferença entre | e > no YAML?

A barra vertical inicia um bloco literal: cada quebra de linha que você digita fica no valor. O sinal de maior que inicia um bloco folded: uma quebra simples entre duas linhas comuns vira um espaço, enquanto linhas em branco viram quebras de linha.

O que significa o sinal de menos em |-?

É o indicador de chomping strip. A última quebra de linha e quaisquer linhas em branco depois do texto são descartadas, então o valor termina no último caractere visível.

O que o + faz depois de | ou >?

É o indicador keep. A última quebra de linha e todas as linhas em branco do final passam a fazer parte do valor. Sem nenhum indicador, o YAML faz clip: mantém uma quebra de linha final e descarta as linhas em branco.

Por que algumas linhas não são unidas no meu bloco >?

Linhas que começam com indentação extra são linhas mais indentadas. O folding nunca as une, então as quebras ao redor delas são preservadas. Isso permite manter um exemplo de código ou uma lista dentro de um texto folded.

Dá para escrever uma string multilinha sem block scalars?

Sim. Uma string entre aspas duplas pode conter escapes \n, e escalares entre aspas ou simples podem continuar por várias linhas, com cada quebra simples virando um espaço. Block scalars ficam mais fáceis de ler quando o texto fica longo.

Como o folding funciona de verdade

O folding só une duas linhas vizinhas que começam na indentação do próprio bloco. Uma quebra entre elas vira um espaço. Se você deixar uma linha em branco, o valor recebe uma única quebra de linha no lugar, e é assim que se escrevem parágrafos.
Uma linha que começa com espaços extras fica como está, assim como as quebras dos dois lados dela. Essa é a regra que a prévia aplica, então tente indentar uma linha para ver isso acontecer.

Indicadores de indentação

Se a primeira linha de conteúdo precisa começar com espaços, o YAML não consegue adivinhar a indentação. Adicione um dígito ao cabeçalho, como em |2, para dizer quantos espaços o bloco está indentado em relação ao pai.
O dígito e o sinal de chomping podem ser combinados em qualquer ordem, por exemplo |2- ou |-2.

Block scalars em arquivos reais

Comandos de shell em uma etapa de CI

O estilo literal mantém cada comando na própria linha, que é o que o shell precisa.

Uma descrição longa unida em um parágrafo

Folded e strip: o valor é uma linha de texto sem quebra de linha no final.

Mantendo linhas em branco no final

Com + a linha em branco depois do texto fica no valor, então a string processada termina com duas quebras de linha.

Prévia de block scalar

Digite o texto, escolha um estilo e um indicador de chomping e veja o YAML que você escreveria ao lado da string exata que um parser retorna.

Texto a guardar

Estilo de bloco

Literal |

Folded >

Indicador de chomping

Strip -

Clip (padrão)

Keep +

Linhas em branco depois do bloco

YAML

String resultante (notação JSON)

{n} caracteres, {b} quebras de linha

Obrigado pelo seu pedido. Ele será enviado em até dois dias. Dúvidas? Responda a este e-mail. Ref. do pedido: 10442

Strings multilinha em YAML: | e >, explicados com prévia ao vivo