Форматирование YAML

О форматировании YAML

Инструмент форматирования YAML проверяет документ и заново записывает его с выбранными отступами. Он помогает привести конфигурацию к единому виду и прочитать вложенные значения без переноса в другой формат.

Почему отступы в YAML имеют значение

YAML описывает пары ключей и значений, списки и отдельные значения. Вложенность обычно задается пробелами: поле, сдвинутое на другой уровень, может относиться к другому объекту. Поэтому форматирование выполняется после разбора структуры, а не простой заменой пробелов.

Неверный отступ иногда создает синтаксически допустимую, но другую конфигурацию. Если результат отличается от ожиданий, сначала проверьте состав объектов и списков, а не только красоту выравнивания.

Как YAML различает отображение, последовательность и строку

Отображение связывает имена ключей со значениями. Последовательность задает элементы в определенном порядке. Строка является одним значением, даже если занимает несколько физических строк. Эти уровни нельзя определить только по количеству переносов в файле.

Особенно внимательно проверяйте многострочные скаляры. Обозначения | и > по-разному интерпретируют переводы строк: один стиль помогает сохранять их, другой сворачивает часть переносов. Заново записанный документ может выбрать другой внешний стиль, сохранив разобранное значение строки.

Якоря и ссылки как способ избежать повторения

Якорь дает имя узлу документа, а ссылка позволяет обратиться к нему из другого места. Это помогает не повторять блок настроек вручную. Но ссылка на уже созданный узел отличается от текста, который просто выглядит как его имя.

В этом инструменте ссылки раскрываются в независимые копии значений. Если после сохранения результата изменить один такой блок, остальные копии автоматически не обновятся. Учитывайте это, когда общие настройки должны оставаться синхронизированными.

Как отформатировать конфигурацию

Вставьте один документ в «Исходный текст», выберите число пробелов и включите сортировку ключей при необходимости. Результат обновится автоматически. «Копировать» и скачивание позволяют перенести оформленный YAML в редактор.

Сортировка действует на поля объектов, не меняя порядок элементов массивов. Это удобно для сравнения настроек в системе контроля версий.

Что не сохраняется при повторной записи

Инструмент создает текст из разобранных данных. Комментарии, исходный стиль кавычек и запись якорей могут исчезнуть или измениться; поддерживаемые ссылки раскрываются в значения. Для конфигурации с важными комментариями сохраните исходный файл перед заменой.

Повторные ключи, неизвестные теги, циклические ссылки и несколько документов отклоняются. Ограничены вложенность и раскрытие ссылок. Проверка не знает схему приложения: успешный разбор не подтверждает правильность названия параметра, пути к файлу или настроек доступа.