Formátovač YAML

Okamžitě formátujte a validujte YAML soubory — komplexní vnořené struktury, kotvy a aliasy podporovány

Podíl:

Formátovač YAML

Proč formátovat YAML soubory?

YAML je extrémně citlivý na problémy s odsazením — jedno extra mezera může způsobit chybu parsování nebo tichá poškození dat. Kubernetes, Docker Compose, GitHub Actions a Ansible používají konfigurační soubory YAML a chyba formátování může zablokovat celé nasazení.

📐

Normalizace odsazení

Normalizuje smíšené odsazení na konzistentní formát 2 mezer v celém dokumentu

Validace syntaxe

Identifikuje chyby odsazení, smíchání tabulátorů/mezer a strukturální problémy

Kotvy a aliasy

Plná podpora pro kotvy YAML (&) a aliasy (*) pro opakované použití dokumentu

Formátování YAML ve 3 krocích

1

Vložte YAML

Vložte manifest Kubernetes, workflow GitHub Actions nebo konfigurační soubor YAML

2

Formátujte a validujte

Nástroj validuje syntaxi a automaticky přeformátuje s konzistentním odsazením

3

Zkopírujte a nasaďte

Zkopírujte formátované YAML do svých souborů, CI pipeline nebo nástrojů nasazení

Případy použití formátování YAML

☸️

Manifesty Kubernetes

Formátujte YAML soubory Deployment, Service a ConfigMap před aplikací na cluster

🔄

CI/CD pipeline

Validujte workflows GitHub Actions, GitLab CI a CircleCI pro předcházení selhání pipeline

📋

Ansible Playbooks

Formátujte a validujte Ansible úkoly, proměnné a inventáře

🐳

Docker Compose

Zkontrolujte, že docker-compose.yml je správně formátován před docker compose up

Nejlepší postupy pro YAML

✓ Používejte mezery, ne tabulátory

Specifikace YAML výslovně zakazuje tabulátor pro odsazení. Nakonfigurujte editor tak, aby při Tab vkládal mezery v YAML souborech.

✓ Používejte uvozovky pro speciální znaky

Řetězce obsahující : # [ ] { } nebo začínající speciálními znaky musí být v uvozovkách, aby YAML správně interpretoval.

✓ Používejte kotvy pro snížení opakování

Kotvy YAML (&název) a aliasy (*název) umožňují opakované použití hodnot v dokumentu.

✓ Spuštění lint před commitem

Spusťte yamllint nebo použijte tento formátovač v pre-commit hooku pro zachycení problémů s formátováním včas.

❓ Nejčastější dotazy

Proč YAML nefunguje s tabulátory místo mezer?

Specifikace YAML výslovně zakazuje tabulátor pro odsazení, protože různé editory zobrazují tabulátory s různou šířkou. Mezery poskytují konzistentní odsazení, které všechny parsery YAML interpretují stejně.

Co dělají kotvy YAML (&) a aliasy (*)?

Kotvy definují opakovaně použitelný blok pomocí &näzevkotvy; aliasy na něj odkazují pomocí *näzevkotvy. Takto lze definovat hodnotu jednou a použít ji na mnoha místech.

Jaký je rozdíl mezi YAML a JSON?

YAML je nadmnožina JSON — platné JSON je také platné YAML. YAML přidává podporu pro komentáře, kotvy, víceřádkové řetězce a čitelnější syntaxi.

Kdy zvolit YAML místo TOML pro konfiguraci?

YAML má širší podporu nástrojů (Kubernetes, Ansible, většina systémů CI) a dokáže vyjádřit složité vnořené struktury stručně. V konfiguraci DevOps je YAML standardem.