Formatador de YAML

Antes e depois

Entrada bagunçada:

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

Formatado (2 espaços, estilo em bloco):

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

Opções de formatação

Regras de aspas

Aspas mínimas costumam ser o que você quer: as strings ficam sem aspas, a menos que deixá-las sem proteção seja arriscado. O formatador adiciona aspas automaticamente para:

• Booleanos legados como strings: yes, no, on, off, y, n. O YAML 1.2 já os lê como strings, mas muitos parsers ainda seguem o YAML 1.1, em que um no sem aspas vira false. O formatador sempre os coloca entre aspas na saída, então o famoso bug da Noruega (NO lido como false numa lista de países) não pega quem consome o seu arquivo.
• Números como strings: '007', '3.14'. Sem aspas, seriam interpretados como inteiros ou decimais.
• Strings com caracteres como :, #, [, { ou espaço no início, em que a saída sem aspas mudaria a estrutura.

Limpezas aplicadas em toda execução

• Espaços no fim da linha. Removidos.
• Indentação misturada ou irregular. Normalizada para a largura de indentação escolhida.
• Linhas em branco dentro de coleções. Removidas.
• Tabs na indentação. O YAML os proíbe; o parser rejeita a entrada com um erro claro apontando a linha, para você corrigir em vez de entregar um arquivo que outros parsers vão recusar.

Comentários, âncoras e chaves de mesclagem

A formatação normaliza o modelo do documento, o que tem limites que vale conhecer antes do commit:

• Comentários são removidos. O parser resolve o documento em dados, então comentários # não sobrevivem à formatação. Guarde uma cópia se os seus comentários importam.
• Âncoras e aliases são resolvidos. Nós compartilhados por alias continuam compartilhados, mas são reemitidos com nomes gerados como &ref_0; os nomes originais das âncoras não são mantidos.
• Chaves de mesclagem (<<:) são resolvidas em mapeamentos comuns, com os valores mesclados no lugar.

Streams com vários documentos

Streams com vários documentos são aceitos: cada documento é formatado de forma independente e reunido de novo com o separador ---, até 100 documentos por execução.