YAML Formatter & Validator
Understand YAML Formatter & Validator
Este formatador reimprime YAML com indentação consistente e informa as estruturas que não consegue ler.
How it works
O YAML usa indentação em vez de colchetes para expressar aninhamento, então o parser acompanha com quantos espaços cada linha começa e monta o mapeamento a partir disso. Os valores são então tipados pelo texto: true e false são booleanos, null e ~ são null, um número solto é número e todo o resto é string, a menos que esteja entre aspas. A saída é reserializada a partir dos valores interpretados, e é por isso que ela volta uniforme — e por isso que qualquer comentário do original desaparece.
When to use it
- Conferir um workflow do GitHub Actions ou um manifesto Kubernetes antes de enviá-lo.
- Achar a linha em que um bloco colado ficou no nível errado de indentação.
- Normalizar a indentação de um arquivo de configuração que várias pessoas editaram.
- Confirmar que um valor que você queria como string não está sendo lido como número ou booleano.
Watch out for
- Tabs nunca são legais na indentação em YAML. Um único tab inserido pelo editor é erro de sintaxe em todo parser conforme, e é invisível — esta é a razão mais comum de um manifesto falhar.
- No YAML 1.1, ainda o padrão no PyYAML e em muita ferramenta antiga, os valores sem aspas yes, no, on e off são booleanos, então um campo de país com NO vira false. Esse é o problema da Noruega. Esta ferramenta segue o YAML 1.2 e os trata como strings, então use aspas de qualquer forma e os dois concordam.
- Os comentários não são preservados. Reformatar devolve os dados, não o arquivo, então não cole o resultado por cima de uma configuração cujos comentários você precisa manter.
- Isto lida com o formato que a maioria dos arquivos de configuração tem: chaves de primeiro nível, mapeamentos aninhados e listas simples. Âncoras e aliases (&defaults, *defaults), escalares de bloco (| e >) e arquivos com vários documentos separados por --- não são reproduzidos.
Not the right tool for: Validar um manifesto contra o schema dele. A sintaxe pode estar perfeita com todos os campos errados; quem verifica isso é o kubeconform, o actionlint ou o validador da própria plataforma.
Frequently Asked Questions
Por que meu YAML está inválido?
Erros comuns de YAML: tabs no lugar de espaços na indentação (o YAML exige espaços), níveis de indentação inconsistentes, caracteres especiais sem aspas (: { } [ ] , # & * ? | - < > = ! % @ `) e valores especiais como "yes" ou "no" tratados como booleanos sem que você espere.
Como incluir dois-pontos em um valor YAML?
Dois-pontos seguidos de espaço iniciam um par chave: valor em YAML. Para incluir dois-pontos literais em um valor, coloque a string inteira entre aspas: message: "Error: connection failed", ou use um escalar de bloco (|) para valores de várias linhas.
Qual versão de YAML é usada aqui?
Este formatador usa YAML 1.2, que é mais rigoroso que o YAML 1.1. Diferente do 1.1, o YAML 1.2 só trata true/false como booleanos (não yes/no/on/off), o que o torna totalmente compatível com JSON.
How to Use YAML Formatter & Validator
- Paste or type your input in the input area above.
- The tool processes your input automatically or click Run.
- Copy or download the result using the action buttons.
- Use Ctrl+Enter to run quickly from the keyboard.