YAML Formatter

Formate e valide documentos YAML.

Resultado

Aguardando conteúdo.

O que faz e quando usar

YAML representa dados por chaves, valores e listas, usando recuo para expressar hierarquia. Um campo servidor com host e porta dentro dele não é a mesma estrutura que três chaves independentes. A indentação participa do significado, em vez de servir apenas como aparência agradável.

Processo utilizado

Um par usa chave: valor; uma lista costuma marcar itens com hífen; linhas recuadas pertencem a um nível interno. A ferramenta verifica indentação e usa a biblioteca yaml para interpretar os valores, depois os serializa em apresentação consistente. O parser reconhece tipos, de modo que true pode ser booleano enquanto "true" pode ser texto.

Aplicação prática e conferência

Prefira espaços e mantenha irmãos no mesmo nível de recuo. Se um número for um identificador, como um código com zeros iniciais, sua intenção textual deve ser declarada. O modo como a biblioteca interpreta uma entrada não garante que uma aplicação externa aceite aqueles campos ou tipos.

Exemplo resolvido

Uma representação YAML válida que deixa os agrupamentos visíveis com delimitadores é: servidor: { host: localhost, porta: 8080 } rotas: [ /inicio, /contato ] servidor aponta para um objeto com host e porta; rotas aponta para uma lista com dois itens. As chaves e colchetes mostram o que pertence a cada valor nessa forma compacta. Na forma de blocos, servidor: fica em uma linha e host e porta ficam abaixo, ambas com o mesmo recuo de espaços. Se porta voltar ao nível externo, deixa de pertencer a servidor. Essa mudança pode continuar sintaticamente válida e representar outra configuração. Por isso entender o agrupamento é mais importante que apenas deixar o texto alinhado.

Leitura do resultado e erros comuns

YAML válido não significa configuração operacional válida. Um serviço pode exigir campos ou formatos que o parser não conhece. A serialização pode mudar comentários, aspas, âncoras e estilo; compare a versão reescrita antes de substituir o original. Nenhum comando declarado no conteúdo é executado pela formatação.

Formatos e limitações

Aceita um documento YAML textual compatível com o parser. Formatação não valida um esquema de configuração, e comentários, aspas, âncoras ou estilo podem mudar na serialização. Não executa comandos declarados no YAML nem confirma compatibilidade com Kubernetes, CI ou outro serviço.

Ferramentas relacionadas

Voltar para Desenvolvimento