Команда: 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 — показывать различия в форматировании.
  • При использовании этого флага убедитесь, что инструмент diff установлен. Он используется внутри команды для повышения удобства работы.
• -check — проверить, отформатированы ли входные данные. Код завершения будет равен 0, если все входные данные отформатированы правильно. В противном случае код завершения будет ненулевым, а команда выведет список имён файлов, отформатированных неправильно.
• -recursive — также обрабатывать файлы во вложенных каталогах. По умолчанию обрабатывается только указанный (или текущий) каталог.