Terraformの自動フォーマットをVSCodeに設定する方法

はじめに

terraform fmtコマンドでtfファイルのコードをフォーマットすることができます。ただ、どうせならエディターの段階で自動フォーマットしてくれた方が楽なので、やり方を調べてみました。
自分でも使っており、人口も多そうなVSCodeでの設定方法をまとめます。

プラグインインストール

こちらのHashiCorp TerraformプラグインをVS Codeにインストールします。

設定ファイルにterraformの設定を追記

settings.jsonに下記の内容を追記します。私はユーザー設定の方に追記しました。

"[terraform]": {
  "editor.defaultFormatter": "hashicorp.terraform",
  "editor.formatOnSave": true,
  "editor.formatOnSaveMode": "file"
},
"[terraform-vars]": {
  "editor.defaultFormatter": "hashicorp.terraform",
  "editor.formatOnSave": true,
  "editor.formatOnSaveMode": "file"
}

[terraform] が tfファイルへの設定で、[terraform-vars]がtfvarsファイルへの設定です。
設定内容はどちらも同じで下記のようになっています。

"editor.defaultFormatter": "hashicorp.terraform", // HashiCorpが提供するTerraform用のデフォルトフォーマッターを指定
"editor.formatOnSave": true, // ファイル保存時に自動でフォーマットを行うように設定
"editor.formatOnSaveMode": "file"

保存時の自動フォーマットにする場合、editor.formatOnSaveModeについては現状file以外サポートされていないようなので、ここはほぼ固定になります。

When using the editor.formatOnSaveMode setting, only file is currently supported.

設定後は、保存時にフォーマットが修正されます。

参考資料