TerraformをVS codeで書く時のコメントをスニペット化してみた

VS codeでスニペットを登録する方法

こちらの記事では、Terraformのコードを書くときに少しだけ手間なコメントの書き方をスニペット化する方法を解説します。

環境

mac OS Ventura 13.2

VS code バージョン: 1.79.2

# やりたいのはこれをスニペット化すること
# ------------------------------
# provider
# ------------------------------

terraform.jsonを開く

画像のCodeから、「基本設定」、ユーザースニペットの構成を選択します。

検索窓へterraformと入力すると、terraform.jsonが表示されるのでクリックします。terraform-varsではないので注意しましょう。

スニペットを登録する

terraform.jsonを開いたら、編集します。

書き方についての詳細は、下記の参考にさせていただいた記事を読んでいただきたいため割愛させていただきます。

terraform.jsonのコード

terraform.json

# varと入力したら${}を入力してくれるスニペット

  "var assign": {
    "prefix": "var",
    "body": ["\"${$1}\""],
    "description": "Variable assign"
  },
# comと入力したら以下のコメントを入力してくれるスニペット

  "create comment": {
    "prefix": "com",
    "body": [
      "# ------------------------------",
      "# ",
      "# ------------------------------"
    ],
    "description": "terraform comment"
  }

こちらを記述して保存すれば、良い感じにコメントを挿入できます。

参考にさせていただいた記事

VSCodeでterraformを楽にするための少しのスニペット

これでまたTerraformを書くのが楽しくなりました。