terraform fmt でコードを整形しよう

「チームで書き方(インデントなど)がバラバラになるのを防ぎたい」というときに使うのがterraform fmtです。設定ファイルを、Terraformの標準的な書式(インデントや空白の統一)に自動整形するコマンドです。

terraform fmtという書式で使います。カレントディレクトリ以下の.tfファイルがすべて対象になり、整形が必要だったファイル名が結果として表示されます。

terraform fmtを実行すると、書式が崩れていたファイルは自動的に整えられます。既に整形済みであれば何も表示されず、変更もありません。

よくあるつまずきは、fmtを実行し忘れたまま提出し、レビューで書式の指摘を受けてしまうことです。コミット前に習慣として実行するか、CI上でチェックする運用がよく取られます。

実務ではコードレビューを書式の些細な違いで消耗しないため、チーム開発ではほぼ必須の運用です。