Зачем сортировать ключи в файлах YAML?
В больших файлах конфигурации врагом являются не сами данные, а движение, скрывающее намерения. Когда ключи перемешиваются без причины, каждый запрос на включение выглядит страшнее, чем он есть на самом деле, и вдумчивые рецензенты в конечном итоге говорят «да», потому что шум невыносим, и именно так проскальзывают настоящие ошибки. Сортировка ключей — это командное соглашение: нам нужен стабильный порядок, поэтому различия связаны с тем, что изменилось, а не с случайным переупорядочением. Для менеджеров программ, маркетологов, которые касаются флажков функций, и любого «белого воротничка», обладающего длинной картой, отсортированный макет также соответствует тому, как люди думают в электронных таблицах: предсказуемый порядок столбцов ускоряет сканирование и облегчает сопоставление списков управления. Боль от несортированной конфигурации — это тонкая боль слияния: два человека трогают один файл, Git кричит, а человек тратит час, решая, имеет ли конфликт смысл, только для того, чтобы узнать, что это был театральный приказ. Шаг сортировки — это любезность по отношению к вашему будущему релиз-менеджеру, который пытается ответить «что изменилось» за пять минут, а не за трехчасовой урок археологии. Бесплатная сортировка YAML-ключей в браузере в первую очередь не является панацеей, поскольку некоторые системы заботятся о порядке, но во многих случаях это большой выигрыш в читабельности. Преимущество — более спокойный просмотр, более спокойная память при вызове и файл, который не похож на шутку. Если вы устали от шумных различий, от которых все вздрагивают, согласуйте правило сортировки, запустите его в одном механическом коммите и двигайтесь дальше с командой, которая может без страха читать один и тот же файл. Эмоциональная отдача немедленная: в следующий раз, когда кто-то попросит небольшое изменение переключателя, это изменение будет видно, а не потеряется в перетасовке колоды, и разговор останется на деловом решении, а не на погоде форматирования. Это маленькая привычка с человеческой отдачей: меньше усталости, больше сосредоточенности и меньше вечеров, потерянных за файлом, который должен был быть скучным. Отсортируйте, когда это безопасно, задокументируйте, когда нет, и вы будете рады, что сделали это в первый раз, когда для релиза нужен четкий ответ.
Как отсортировать ключи YAML и исправить отступ
- Создайте резервную копию файла, поскольку изменение порядка по-прежнему является реальным изменением для некоторых потребителей, чувствительных к порядку, — проверьте, прежде чем считать сортировку безопасной везде.
- Запустите сортировку, если ваш инструмент ее предлагает, а затем исправьте отступы во вложенных картах, чтобы дочерний ключ никогда случайно не выходил за пределы и не выглядел как родственный.
- Повторно запустите конвейер и любую проверку схемы, которая требуется вашей организации после изменения порядка, поскольку небольшой структурный сюрприз может быть хуже, чем большое визуальное изменение.