O que o Validador de YAML verifica?

YAML é o formato usado por muitos arquivos de configuração: arquivos do Docker Compose, manifestos do Kubernetes, fluxos de trabalho do GitHub Actions e do GitLab CI, playbooks do Ansible, especificações do OpenAPI e configurações de inúmeros aplicativos. Como a indentação tem significado em YAML, um espaço ausente, uma tabulação perdida ou uma chave repetida pode causar problemas difíceis de detectar. O validador lê seu YAML como um analisador sintático e lista cada problema com sua linha e coluna.

Como usar

  1. Cole ou digite YAML no editor.
  2. O resultado aparece enquanto você digita: ou o YAML é válido, com o número de documentos que contém, ou todos os problemas são listados na ordem em que aparecem no texto.
  3. Cada problema é marcado no editor: erros em vermelho e avisos em amarelo. Clique em um problema para rolar o editor até ele ou clique em uma marcação para encontrá-lo na lista.

O que ele encontra

  • Erros de sintaxe: aspas e colchetes não fechados, itens com indentação insuficiente ou excessiva, uma chave e um item de lista misturados no mesmo nível, mapeamentos aninhados em uma única linha, como a: b: c.
  • Chaves repetidas: a mesma chave duas vezes em um mapeamento. A maioria dos analisadores manteria silenciosamente apenas um dos valores, descartando a outra configuração.
  • Tabulações usadas na indentação: YAML permite apenas espaços na indentação.
  • Aliases sem âncoras: um alias *name precisa de uma âncora &name anterior no mesmo documento.
  • Avisos sobre elementos que podem ser analisados, mas talvez não funcionem como esperado, como uma tag desconhecida para o analisador ou uma versão %YAML não compatível.

A mesma chave em mapeamentos diferentes não causa problemas, assim como um arquivo com vários documentos separados por ---: as linhas são contadas no arquivo inteiro.

O que ele não verifica

O validador verifica se o texto é YAML válido, não se um programa específico o aceita. Um arquivo do Docker Compose pode ser YAML válido e ainda assim definir uma configuração desconhecida pelo Docker Compose. As mensagens vêm da biblioteca yaml e estão em inglês.

Como funciona

A ferramenta analisa o texto com a biblioteca yaml, que segue a especificação YAML 1.2 e exige que as chaves sejam únicas. Tudo é executado no seu navegador: seus arquivos nunca são enviados.

Recursos

  • Erros de sintaxe com linha e coluna
  • Chaves repetidas, tabulações na indentação e aliases sem âncoras
  • Erros e avisos marcados no editor, com clique para rolar até o local
  • Arquivos com vários documentos
  • Executado no seu navegador