Loading…

Sobre este Formatador YAML Formatador e Embelezador YAML Online

Trabalhando com `values.yaml`, `docker-compose.yml` ou fluxos de trabalho GitHub Actions desorganizados? Este formatador YAML normaliza a indentação e a quebra de linha, preservando âncoras, aliases e escalares de bloco. Cole seu YAML, ajuste as configurações de indentação e copie de volta uma configuração limpa e pronta para revisão em segundos. 🚀

Principais Características Deste Formatador de YAML

  • Formatação baseada em Prettier ajustada para arquivos de configuração YAML 1.2
  • Indentação consistente com tamanho de indentação configurável (1–8) e espaços vs tabs
  • Comprimento de linha/ajuste ajustável para que chaves e valores longos permaneçam legíveis
  • Lida corretamente com âncoras, aliases, booleanos-como-strings e escalares de bloco multilinha
  • Funciona com arquivos `.yaml` e `.yml` para Kubernetes, Docker Compose, pipelines de CI e mais
  • Cole YAML do seu editor ou arraste e solte arquivos de configuração no formatador
  • Cópia com um clique do YAML formatado de volta para seu editor ou repositório
  • A formatação ocorre principalmente no lado do cliente no seu navegador; um fallback seguro do servidor pode ser usado apenas se um parser/plugin necessário estiver faltando

🔧 Como FormatArquivos de Configuração YAML for yaml-formatter

1

1. Cole ou Carregue Seu YAML

Copie qualquer trecho de YAML (manifesto Kubernetes, `docker-compose.yml`, workflow do GitHub Actions, playbook Ansible, etc.) e cole no editor, ou arraste e solte um arquivo `.yaml` / `.yml`.

2

2. Ajuste Indentação e Quebra de Linha

Escolha usar espaços ou tabs, defina o tamanho da indentação (1–8 espaços) e ajuste a quebra/comprimento de linha para corresponder ao estilo da sua equipe. Um comprimento de quebra de `0` efetivamente desativa a quebra usando um `printWidth` interno muito grande.

3

3. Execute o Formatador

Clique no botão **Formatar**. O mecanismo YAML baseado em Prettier reescreve sua configuração com indentação consistente enquanto preserva âncoras, aliases e escalares de bloco para que a semântica não mude.

4

4. Copie o YAML Limpo

Revise a saída, então copie o YAML formatado de volta para seu editor, faça commit no Git ou cole na sua CI/CD ou interface do provedor de nuvem.

Especificações Técnicas

Mecanismo de Formatação & Suporte YAML

Esta ferramenta é construída sobre um formatador YAML baseado em Prettier com opções de configuração disponíveis na interface.

CaracterísticaSuporteNotas
Versão YAML✅ YAML 1.2 (típico)Adequado para YAML de estilo de configuração moderno usado em Kubernetes, Docker, CI/CD e aplicativos.
Âncoras e aliases✅ PreservadoMantém referências `&anchor` e `*alias` intactas enquanto reidenta a estrutura circundante.
Escalares de bloco✅ PreservadoMantém escalares de bloco `|` e `>` com a indentação interna respeitada.
Booleanos e números✅ Manipulação cuidadosaA formatação mantém os valores, mas pode expor diferenças entre `yes` versus "yes" ou `0012` versus "0012".
YAML de múltiplos documentos (`---`)✅ TípicoMúltiplos documentos no mesmo arquivo são mantidos em ordem e formatados consistentemente.
Se um snippet YAML específico usar sintaxe extremamente exótica ou tags personalizadas que o analisador YAML do Prettier integrado não entende, você pode ver um erro de análise. Nesse caso, simplifique o snippet ou execute a formatação localmente com sua própria cadeia de ferramentas.

Indentação, Comprimento de Linha e Estilo de Saída

O formatador expõe opções-chave para que você possa corresponder o mais próximo possível ao estilo do seu projeto.

ConfiguraçãoOpçõesRecomendação Prática
Estilo de indentaçãoEspaços / TabsA maioria dos guias de estilo YAML recomenda espaços; tabs apenas se sua equipe preferir explicitamente.
Tamanho da indentação1–8 espaços2 espaços é comum para Kubernetes e Docker; 4 espaços para maior clareza visual.
Quebra / comprimento de linha0–120 colunas`0` desativa a quebra (usa um `printWidth` interno muito grande), 80–100 mantém os diffs compactos.
Extensões de arquivo.yaml, .ymlCorresponde ao `fileExtensions` e `acceptedFileTypes` na configuração da ferramenta.
Alinhe essas opções com o `.prettierrc` ou `.editorconfig` do seu repositório para que a formatação online corresponda ao desenvolvimento local e verificações de CI.

Limites e Desempenho

Otimizado para formatação interativa de configurações YAML em uma aba do navegador.

ParâmetroLimite / ComportamentoNotas
Tamanho máximo de entrada de texto≈ 2 MB (~2.000.000 caracteres)Limite de segurança aplicado dentro da função de formatação.
Tamanho máximo de upload de arquivo≈ 5 MBLimitado pela configuração `maxFileSize` da UI para conveniência e confiabilidade.
Tempo limite de formatação~25 segundosOperações de longa duração são abortadas para evitar que o navegador trave.
Execução principalLado do clienteExecuta via `runPrettier` e um plugin YAML do Prettier diretamente no seu navegador.
Fallback do servidorApenas em erros de parser/pluginSe um plugin de parser necessário estiver faltando, um endpoint seguro `/api/yaml-formatter` pode ser usado como fallback.
Para pacotes YAML enormes (gráficos Helm, bibliotecas gigantes de CRD, etc.), prefira CLIs como `prettier` ou `yq` integrados ao seu fluxo de trabalho local ou pipelines de CI.

Alternativas de CLI para Formatação YAML

Use o formatador online para limpezas rápidas e confie em ferramentas CLI para projetos grandes e pipelines automatizados.

Linux / 🍏 macOS

Formatar um arquivo YAML com yq (pretty-print)

yq eval -P config.yaml > config.formatted.yaml

Reescreve YAML com indentação consistente e ordenação de chaves dependendo da versão do yq.

Normalizar YAML com Prettier

prettier --parser yaml --write "**/*.{yaml,yml}"

Executa a mesma classe de mecanismo (parser YAML do Prettier) em todo o seu repositório.

Windows (PowerShell / cmd)

Formatar YAML usando PowerShell + yq

yq eval -P config.yaml | Set-Content config.formatted.yaml

Faz pretty-print do YAML e grava o resultado de volta no disco.

Round-trip YAML via objetos PowerShell

Get-Content config.yaml -Raw | ConvertFrom-Yaml | ConvertTo-Yaml | Set-Content config.formatted.yaml

Usa o suporte a YAML do PowerShell para normalizar estrutura e indentação.

Combine este formatador online com uma etapa `prettier --check` ou `yq` no seu pipeline de CI para garantir que todo YAML no repositório permaneça consistentemente formatado.

Casos de Uso Práticos de YAML

Infraestrutura & Manifestos Kubernetes

  • Formatar manifestos Kubernetes `Deployment`, `Service` e `Ingress` antes da revisão de código.
  • Normalizar arquivos `values.yaml` em gráficos Helm para tornar os diffs mais limpos.
  • Manter CRDs, ConfigMaps e Secrets YAML consistentemente indentados entre ambientes.
apiVersion: apps/v1
kind: Deployment
metadata:
  name: my-app
spec:
  replicas: 3
  selector:
    matchLabels:
      app: my-app
  template:
    metadata:
      labels:
        app: my-app
    spec:
      containers:
        - name: my-app
          image: my-app:latest
          ports:
            - containerPort: 80

Docker Compose & Configuração de Desenvolvimento Local

  • Embelezar `docker-compose.yml` antes de compartilhá-lo em documentação ou tickets.
  • Alinhe a indentação de serviços, redes e volumes para facilitar a manutenção.
  • Prepare trechos limpos de YAML para posts de blog e guias de integração.
version: "3.9"
services:
  web:
    image: myapp:latest
    ports:
      - "8080:80"
    environment:
      - NODE_ENV=production
  db:
    image: postgres:16
    environment:
      POSTGRES_PASSWORD: example

Pipelines de CI/CD e Automação

  • Formate fluxos de trabalho do GitHub Actions (`.github/workflows/*.yml`).
  • Limpe o GitLab CI (`.gitlab-ci.yml`) ou YAML do Azure Pipelines.
  • Mantenha a automação e YAML de infraestrutura como código legível entre equipes.
name: CI
on:
  push:
    branches: [ main ]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 22
      - run: npm ci
      - run: npm test

❓ Frequently Asked Questions

O que este formatador de YAML faz?

Ele recebe entrada YAML (normalmente arquivos de configuração) e a reescreve com indentação e quebra de linha consistentes usando um mecanismo YAML baseado no Prettier. A semântica da sua configuração permanece a mesma, mas o layout se torna muito mais fácil de ler e revisar.

🧩Quais recursos do YAML são suportados?

O formatador é projetado para recursos comuns do YAML 1.2 usados em arquivos de configuração: mapeamentos, listas, âncoras e aliases, escalares de bloco (`|` / `>`), e arquivos de múltiplos documentos separados por `---`. Tags personalizadas e construções muito exóticas podem não ser totalmente suportadas pelo analisador subjacente.

📏Há um limite de tamanho para a entrada YAML?

Para estabilidade e desempenho do navegador, a entrada de texto é limitada a cerca de 2 MB (~2.000.000 caracteres) e arquivos carregados a aproximadamente 5 MB. Para bases de código maiores ou YAML gerado, execute o Prettier ou yq a partir da sua CLI ou pipeline de CI em vez disso.

🔐Meu YAML é enviado para um servidor?

A formatação é executada principalmente no seu navegador via `runPrettier` e o plugin YAML do Prettier, então seu YAML não deixa o cliente em operação normal. Em casos raros onde um plugin de analisador necessário está ausente, a ferramenta pode recorrer a um endpoint seguro `/api/yaml-formatter`. Mesmo assim, seu YAML é apenas processado temporariamente e não armazenado.

⚠️Por que às vezes vejo erros de analisador?

Erros de analisador geralmente significam que o YAML está malformado (ex.: indentação inconsistente, `:` ausente ou itens de lista desalinhados) ou usa sintaxe que o analisador integrado não entende. Valide a indentação e estrutura, ou tente simplificar o trecho, então execute o formatador novamente.

📚Como isso se relaciona com minha configuração local do Prettier?

Esta ferramenta usa um mecanismo YAML baseado no Prettier internamente, semelhante a executar `prettier --parser yaml`. Você pode usá-la para correções rápidas e pontuais e ainda depender do seu `.prettierrc` local e comandos CLI para formatação de projeto completo.

Pro Tips

Best Practice

Normalize todo YAML em um repositório (Kubernetes, GitHub Actions, Docker Compose) com o mesmo estilo de indentação para tornar diffs e revisões muito mais fáceis.

Best Practice

Tenha cuidado com valores como `yes`, `no`, `on`, `off`, `0012` – coloque-os entre aspas se quiser que sejam tratados como strings em vez de booleanos ou números semelhantes a octais.

Best Practice

Use este formatador online para limpar rapidamente trechos para documentação ou tickets, depois confie no `prettier` ou `yq` em hooks de pré-commit para projetos completos.

CI Tip

Ao refatorar configurações grandes, formate primeiro para que as alterações semânticas se destaquem claramente nos diffs do Git, em vez de ficarem enterradas no ruído de indentação.

Additional Resources

Other Tools