Команда: fmt

Команда tofu fmt используется для перезаписи файлов конфигурации OpenTofu в каноническом формате и стиле. Эта команда применяет подмножество соглашений по стилю языка OpenTofu, а также вносит другие незначительные изменения для повышения удобочитаемости.

Другие команды OpenTofu, создающие конфигурацию OpenTofu, будут генерировать файлы конфигурации, соответствующие стилю, задаваемому tofu fmt, поэтому использование этого стиля в собственных файлах обеспечит единообразие.

Канонический формат может незначительно меняться между версиями OpenTofu, поэтому после обновления OpenTofu мы рекомендуем заблаговременно запускать tofu fmt для ваших модулей наряду с другими изменениями, которые вы вносите для перехода на новую версию.

Мы не считаем новые правила форматирования в tofu fmt несовместимым изменением в новых версиях OpenTofu, но стремимся свести к минимуму изменения для конфигураций, уже соответствующих примерам стиля, приведённым в документации OpenTofu. При добавлении новых правил форматирования они обычно призваны применять больше правил, уже представленных в примерах конфигурации в документации, поэтому мы рекомендуем следовать описанному в документации стилю даже в тех случаях, которые tofu fmt пока не обрабатывает автоматически.

Решения по форматированию всегда субъективны, поэтому вы можете не соглашаться с решениями, которые принимает tofu fmt. Эта команда намеренно придерживается определённого мнения и не имеет параметров настройки, поскольку её основная цель — способствовать единообразию стиля в разных кодовых базах OpenTofu, хотя выбранный стиль не может нравиться всем.

Мы рекомендуем придерживаться соглашений по стилю, применяемых tofu fmt при написании модулей OpenTofu, но если результаты покажутся вам особенно неприемлемыми, вы можете отказаться от использования этой команды и, возможно, выбрать сторонний инструмент форматирования. Если вы решите использовать сторонний инструмент, вам также следует запускать его для файлов, автоматически создаваемых OpenTofu, чтобы обеспечить единообразие рукописных и сгенерированных файлов.

Использование​

Использование: tofu fmt [options] [target...]

По умолчанию fmt выполняет поиск файлов конфигурации в текущем каталоге. Если в качестве аргумента target указать каталог, fmt будет выполнять поиск в этом каталоге. Если указать файл, fmt обработает только этот файл. Если указать одиночный дефис (-), fmt будет читать данные из стандартного потока ввода (STDIN).

Все флаги командной строки необязательны. Доступны следующие флаги:

• -list=false — Не выводить список файлов, содержащих несоответствия форматирования.
• -write=false — Не перезаписывать входные файлы. (Этот режим подразумевается при использовании -check или при вводе из STDIN.)
• -diff — Отображать различия в форматировании.
• -check — Проверить, отформатированы ли входные данные. Код завершения будет равен 0, если все входные данные отформатированы правильно. В противном случае код завершения будет ненулевым, а команда выведет список имён файлов, которые отформатированы неправильно.
• -recursive — Также обрабатывать файлы во вложенных каталогах. По умолчанию обрабатывается только указанный каталог (или текущий каталог).