Форматировщик TOML
Форматируйте файлы конфигурации TOML, например Cargo.toml, pyproject.toml и другие настройки приложений, с помощью плагина Prettier TOML. Форматировщик приводит к единому виду пробелы вокруг знаков равенства, встроенные таблицы и массивы, отделяет таблицы пустой строкой, сохраняет все комментарии и сообщает о синтаксических ошибках с указанием строки и столбца. Это позволяет разработчикам безопасно привести конфигурацию в порядок перед коммитом.
Часто задаваемые вопросы
Какой движок форматирует TOML?
Инструмент использует Prettier 3 с prettier-plugin-toml 4.1 на сервере. Он читает документы TOML 1.0 и выводит их в едином стиле.
Что меняется в результате?
Между ключами и значениями ставится один пробел с каждой стороны знака равенства, а встроенные таблицы и массивы форматируются с равномерными пробелами. Лишние пустые строки удаляются, а каждый заголовок таблицы отделяется от предыдущего раздела пустой строкой.
Сохраняются ли комментарии?
Да. Комментарии на отдельных строках и в конце строк после значений остаются на прежних местах, поэтому пояснения в конфигурационных файлах сохраняются.
Будут ли ключи или таблицы отсортированы?
Нет. Ключи, таблицы и массивы таблиц сохраняют исходный порядок, что важно для файлов, которые читают сверху вниз.
Могут ли измениться кавычки строк?
Строки-литералы в одинарных кавычках могут быть переписаны в двойных кавычках, если значение не содержит обратной косой черты или двойной кавычки, так что само значение останется прежним. Строки, которым нужны буквальные кавычки, сохранят одинарные.
Как обрабатываются длинные массивы?
Массивы, помещающиеся в заданную ширину строки, остаются в одной строке. Массивы с завершающей запятой или превышающие эту ширину выводятся по одному элементу на строку.
Что происходит с некорректным TOML?
Форматирование прекращается, и инструмент показывает сообщение парсера с указанием строки и столбца, например о том, что после знака равенства отсутствует значение. Дублирующиеся ключи и другие ошибки в TOML отображаются так же.
Можно ли изменить отступ?
Да. Для вложенных массивов выберите 2 или 4 пробела либо табуляцию, а также ширину строки от 40 до 200 символов; по умолчанию — 80.
Каков максимальный размер файла?
До 1 MB текста на запрос — намного больше, чем обычно содержат конфигурационные файлы. Форматирование прекращается через 10 секунд.
Сохраняется ли моя конфигурация?
Нет. Конфигурационные файлы могут содержать секреты, поэтому их содержимое обрабатывается только в памяти и никогда не сохраняется и не попадает в журналы.