Форматування й валідація YAML

Що це таке

YAML популярний у конфігураційних файлах — маніфестах Kubernetes, workflow GitHub Actions і GitLab CI, Docker Compose, плейбуках Ansible, документах OpenAPI, — бо його легко читати. Але й зламати його легко: неправильний відступ, символ табуляції, незакрита лапка чи пропущений пробіл після двокрапки можуть змінити зміст файлу або завадити його завантаженню.

Цей валідатор розбирає ваш YAML і повідомляє про кожну синтаксичну помилку з рядком і стовпцем, а також про попередження на кшталт невідомих директив. Якщо YAML коректний, показуються кількість документів і тип кореневого значення кожного з них, а також можна вивести охайно відформатовану копію з єдиним відступом.

Як користуватися

1. Вставте YAML у поле введення, завантажте файл .yaml або .yml чи натисніть Приклад.
2. Результат з’являється під час введення: зелена позначка YAML коректний або список помилок на кшталт Рядок 3, стовпець 2.
3. Залиште увімкненим Показувати відформатований YAML, щоб отримати охайну копію, і виберіть відступ у 2 або 4 пробіли. Скопіюйте її кнопкою над блоком.
4. Вимикайте Повторювані ключі — помилка, лише якщо ваші інструменти дозволяють повторювані ключі.

Поширені помилки

server:
  port: 8080
   host: localhost   # indented one space too far
tags: [web, api      # missing closing bracket

• Неузгоджені відступи: елементи одного рівня мають починатися в одному стовпці. YAML не дозволяє табуляцію у відступах.
• Немає пробілу після двокрапки: key:value — це звичайний рядок, а не ключ і значення.
• Спецсимволи без лапок: значення, що починаються з *, &, !, %, @ або зворотної лапки чи містять : або #, треба брати в лапки.
• Несподівані типи: yes, no, on і off у YAML 1.2 — рядки, а в старих парсерах YAML 1.1 — логічні значення; про всяк випадок беріть їх у лапки. Номери версій на кшталт 1.10 без лапок перетворюються на число 1.1.

Перевірка структури

Цей інструмент перевіряє синтаксис — тобто чи є текст правильно сформованим YAML. Щоб перевірити, чи має файл потрібні ключі та типи значень, перетворіть його інструментом YAML у JSON і перевірте результат валідатором JSON Schema.