Форматер YAML

До и после

Неаккуратный ввод:

server:
  port:   8080
  hosts: ["api.example.com",  "api2.example.com"]
  timeout:  30
  debug: true

Отформатировано (2 пробела, блочный стиль):

server:
  port: 8080
  hosts:
    - api.example.com
    - api2.example.com
  timeout: 30
  debug: true

Опции форматирования

Правила кавычек

Минимальные кавычки обычно то, что нужно: строки остаются без кавычек, если только это не опасно. Форматер добавляет кавычки автоматически для:

• Устаревших булевых значений в виде строк: yes, no, on, off, y, n. YAML 1.2 уже читает их как строки, но многие парсеры до сих пор следуют YAML 1.1, где no без кавычек превращается в false. Форматер всегда берёт их в кавычки на выводе, поэтому знаменитый «норвежский баг» (NO в списке стран, прочитанное как false) не укусит того, кто читает ваш файл.
• Чисел в виде строк: '007', '3.14'. Без кавычек они были бы разобраны как целые или дробные числа.
• Строк с символами вроде :, #, [, { или пробелом в начале, где голый вывод изменил бы структуру.

Чистки при каждом запуске

• Пробелы в конце строк. Удаляются.
• Смешанные или неровные отступы. Приводятся к выбранной ширине отступа.
• Пустые строки внутри коллекций. Удаляются.
• Табуляция в отступах. YAML её запрещает; парсер отклоняет ввод с понятной ошибкой, указывающей на строку, чтобы вы исправили её, а не выпустили файл, который другие парсеры не примут.

Комментарии, якоря и ключи слияния

Форматирование нормализует модель документа, и у этого есть ограничения, о которых стоит знать до коммита:

• Комментарии удаляются. Парсер сводит документ к данным, поэтому комментарии # не переживают форматирование. Сохраните копию, если комментарии важны.
• Якоря и алиасы разрешаются. Узлы, разделяемые через алиас, остаются общими, но выводятся заново со сгенерированными именами вроде &ref_0; исходные имена якорей не сохраняются.
• Ключи слияния (<<:) разрешаются в обычные маппинги с уже подставленными значениями.

Потоки из нескольких документов

Потоки с несколькими документами поддерживаются: каждый документ форматируется независимо и снова соединяется разделителем ---, до 100 документов за запуск.