10
1

More than 1 year has passed since last update.

【VSCode】Prettierを効かせつつterraformも自動整形したい

Posted at

これは何?

VSCodeで、ファイル保存時はPrettierを走らせて自動整形したい開発者が多いと思います。
一方、terraform(.tf)でも保存時にterraform fmtしてほしい、、そんな時の対処法を書き留めときます。

いきなり答え

settings.json に下記を追記すれば解決です。

settings.json
  "[terraform]": {
    "editor.defaultFormatter": "hashicorp.terraform",
    "editor.formatOnSave": true,
    "editor.codeActionsOnSave": {
      "source.formatAll.terraform": true
    }
  },
  "[terraform-vars]": {
    "editor.defaultFormatter": "hashicorp.terraform",
    "editor.formatOnSave": false,
    "editor.codeActionsOnSave": {
      "source.formatAll.terraform": true
    }
  }

何を解決したのか

単純にterraformだけ自動整形したければ、

  • terraformの拡張機能をインストール
  • VSCodeの設定からformatOnSaveをチェック
  • Default FormatterをHashicorp Terraformに設定

でOKです。

image.png

ただこれだとdefaultFormatterが Prettier じゃないので、terraform以外の開発する時にいちいちDefaultFormatterをPrettierに戻さないといけず、超面倒です。

image.png

そこで冒頭の設定を追記すれば、デフォルトをPrettierに維持しつつ、terraformもファイル保存時に自動整形することができ、いい感じに自動整形を効かせられるようになりました。
これでまた一つ幸せになりました。

参考

10
1
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
10
1