Ajuda

Validador YAML: confira seu YAML enquanto digita

Cole seu YAML e este validador YAML confere o texto enquanto você digita. Cada erro de sintaxe é explicado em linguagem simples, com linha e coluna. Ele encontra recuo com tabulação, chaves duplicadas, aspas e colchetes sem fechar e espaços não separáveis invisíveis que parecem recuo, mas não são. Seu YAML é conferido no seu navegador e nunca é enviado.


Validar YAML online: passo a passo

Cole ou digite seu YAML na caixa YAML. Não há botão de validar: o texto é conferido em tempo real.

  1. O texto colado é conferido na hora. Enquanto você digita, a conferência roda cerca de um quarto de segundo depois da sua última tecla, um pouco depois para textos muito grandes. O resultado anterior fica esmaecido até o novo chegar.
  2. Leia o quadro abaixo do editor. Um quadro verde YAML válido significa que a sintaxe está correta. Um quadro vermelho YAML inválido (ou “YAML inválido: N problemas”) lista o que está errado.
  3. Cada problema traz uma frase, “Linha N, coluna M” e um trecho da linha com números de linha: duas linhas acima, uma abaixo e um ^ sob a coluna.
  4. Pressione Mostrar no editor para selecionar essa linha na caixa, corrija e veja o quadro ficar verde.

Só o primeiro erro de sintaxe de cada documento é informado. Os seguintes costumam ser efeitos colaterais, como uma aspa faltando que engole as linhas abaixo. As chaves duplicadas e os aliases sem definição são sempre listados todos, e até 20 problemas são exibidos.

Verificar YAML: problemas comuns e como corrigir

Cada problema é explicado em uma frase, em vez de uma mensagem crua do analisador. Estes são os mais comuns:

O que significam as mensagens de outros analisadores

Chegou aqui por uma mensagem no terminal ou no log de CI? Veja como as formulações comuns correspondem ao que este validador informa. Cole o mesmo arquivo e ele mostra a linha.

A redação muda entre analisadores (PyYAML, js-yaml, Ruby, Go, os carregadores do Home Assistant e do ESPHome), e um analisador costuma informar uma linha abaixo do erro real. Este validador aponta a linha que consegue mostrar.

Tabulações e caracteres invisíveis

Os dois erros mais difíceis de ver em YAML são os que você não enxerga. Este validador os torna visíveis.

Um exemplo: em um arquivo com server: e, abaixo, port: 8080, a última linha, host: example.com, começa com dois espaços não separáveis em vez de dois espaços. O YAML a lê como outra chave de nível superior, e host não é filho de server. O quadro amarelo nomeia o caractere e a linha.

Formatar YAML online e copiar o resultado

Ative a chave Formatar YAML acima da caixa. Ela vem desativada. Quando o texto é válido, aparece um bloco YAML formatado com um botão Copiar acima, que muda para Copiado ao copiar. A formatação é previsível:

Só YAML válido é formatado, então ela não conserta um arquivo quebrado: corrija os erros primeiro. Uma saída muito longa é exibida cortada após 600.000 caracteres, e Copiar ainda copia tudo.

Validar arquivo YAML: usos, tamanho e limites

A conferência é a mesma para qualquer uso do YAML. Serve para fluxos de trabalho do GitHub Actions, docker-compose.yml, manifestos do Kubernetes e valores do Helm, arquivos OpenAPI, playbooks do Ansible, a configuração do Home Assistant, modelos do CloudFormation e a configuração do mkdocs. Cole o arquivo antes de fazer o commit e os erros de sintaxe aparecem sem esperar uma execução de CI. Um arquivo com vários documentos separados por --- é conferido documento por documento, e o quadro verde informa quantos encontrou. Âncoras (&nome) e aliases (*nome) são conferidos. Tags personalizadas como !Ref, !Sub e !GetAtt do CloudFormation, ou !reference do GitLab, são aceitas como válidas.

A conferência roda em um Web Worker no seu navegador. Arquivos típicos de configuração, CI e Kubernetes são conferidos num piscar de olhos. O limite é de 5.000.000 de caracteres, e um texto perto dele leva alguns segundos e usa muita memória. Acima do limite, você é convidado a colar um trecho menor.

Só a sintaxe YAML é conferida. Ele não sabe o que uma ferramenta específica espera, então campos do Kubernetes, chaves do GitHub Actions ou do Docker Compose e regras de JSON Schema não são conferidos, e um nome de chave escrito errado continua passando. Segue o YAML 1.2, então as palavras yes, no, on e off do YAML 1.1 são texto comum e nunca são julgadas. Não executa, busca nem carrega nada, e um retorno de carro antigo do Mac isolado não é tratado como quebra de linha.

Trabalha com outros formatos? Organize e confira JSON com o Formatador de JSON, confira-o contra um esquema com o Validador de JSON Schema ou confira marcação com o Validador de XML. Procura um padrão na sua configuração? Teste no Testador de Regex.


Perguntas frequentes

Como faço para validar um arquivo YAML online?

Cole seu YAML na caixa “YAML”. O texto é conferido enquanto você cola ou digita, então não há botão para apertar. Um quadro verde “YAML válido” significa que a sintaxe está correta. Um quadro vermelho “YAML inválido” mostra cada problema em linguagem simples, com “Linha N, coluna M” e um trecho da linha.

Por que o YAML diz que tabulações não são permitidas no recuo?

O YAML só permite espaços para recuar, e uma tabulação no começo de uma linha é um erro de sintaxe. Os editores costumam inserir tabs quando você aperta a tecla Tab, ou o tab vem com o texto colado. O validador informa que a linha está recuada com uma tabulação. Troque-a por espaços.

O que significa “mapping values are not allowed here” no YAML?

Em geral há um segundo dois-pontos em uma linha, como em “a: b: c”, ou um valor sem aspas contém dois-pontos. Também pode ser uma linha recuada sob uma chave que já tem valor. Coloque o valor entre aspas ou escreva o par interno em uma linha própria com recuo.

O que significa “did not find expected key” no YAML?

Uma linha não está alinhada com as outras chaves do seu mapeamento. Em geral uma chave tem um espaço a mais ou a menos que as vizinhas. Dê a todas as chaves do mesmo nível o mesmo recuo. O validador informa isso como uma linha que não se alinha com as outras chaves.

Como encontro chaves duplicadas no YAML?

Cole o texto. As chaves duplicadas no mesmo mapeamento são sempre listadas todas, cada uma com linha e coluna. Em geral um bloco copiado deixou uma chave repetida. Una as entradas ou apague a repetida.

Por que um arquivo válido mostra “Válido, mas confira esta linha”?

Uma linha começa com um espaço invisível, por exemplo um espaço não separável. O YAML o lê como parte da chave, então a linha não está de fato recuada, mesmo com o arquivo válido. O quadro amarelo nomeia o caractere e a linha. Apague-o e digite espaços normais.

Posso conferir aqui um YAML do GitHub Actions, do Docker Compose ou do Kubernetes?

Sim, a conferência de sintaxe é a mesma para qualquer YAML. Serve para fluxos de trabalho, docker-compose.yml, manifestos do Kubernetes e muitos outros arquivos. Só a sintaxe é conferida: o validador não sabe quais chaves cada ferramenta espera, e um nome de chave escrito errado continua passando.

Qual o tamanho máximo de um arquivo YAML que posso conferir?

O limite é de 5.000.000 de caracteres. Arquivos de configuração comuns são conferidos num piscar de olhos, e um texto perto do limite leva alguns segundos e usa muita memória. Acima do limite, você é convidado a colar um trecho menor.