Languages and frameworks: Terraform

Run Terraform using gutter icon

1. In a Terraform file, click in the gutter.

2. In the window that opens, select either Plan to create an execution plan or Apply if you already have a Terraform plan and want to apply it.

   

If the Terraform initialization step was not performed for this directory, there will be a warning sign in the Run gutter icon. In this case, JetBrains Rider suggests you running the terraform init command before running terraform plan or terraform apply.

Running Terraform from the gutter icon creates a temporary run configuration. You can save it as a permanent one by clicking in the run widget and selecting Save Configuration.

Create Terraform run configuration manually

1. Go to Run | Edit Configurations. Alternatively, press Alt+Shift+F10, then 0.

2. Click the Add New Configuration button () and start typing Terraform.

   

3. Select a type of the run configuration:

   • Terraform Init to run terraform init commands

   • Terraform Validate to run terraform validate commands

   • Terraform Plan to run terraform plan commands

   • Terraform Apply to run terraform apply commands

   • Terraform Destroy to run terraform destroy commands

   • Terraform, which lets you provide any other Terraform command

4. Give the run configuration a name and, if necessary, change the working directory. If you use environment variables, specify them in the Environment variables field or select a file to use variables from it.

Use Terraform formatter

The Terraform formatting tool (terraform fmt) is based on the Terraform code style. It applies to .tf and .tfvars files.

The use of the Terraform formatting tool requires Terraform to be installed.

• In the main menu, go to Code | Terraform Tools | Format file.

• Alternatively, press Ctrl+Alt+Shift+F.

While the Terraform formatter terraform fmt applies to an entire file, JetBrains Rider formatter can also be applied to a selected piece of code.

Use JetBrains Rider formatter

JetBrains Rider formatter is based on the JetBrains Rider code style provided by the Terraform and HCL plugin. You can customize this code style in the IDE settings, under Editor | Code Style | Terraform.

In addition to .tf and .tfvars, it also applies to .hcl files.

• To reformat a file, open it in the editor and, in the main menu, go to Code | Reformat File. Or press Ctrl+Alt+Shift+L.

• To reformat part of the code, select a piece of code and, in the main menu, go to Code | Reformat Code. Or press Ctrl+Alt+L.

Navigate to template file

In a Terraform file, you can use the templatefile function to inject a template. With JetBrains Rider, you can quickly navigate to the template file from your Terraform file.

1. In your Terraform file, locate the templatefile function.

2. Place the caret at the template file name and press Ctrl+B.

Select template data language

If the language is specified in the template file extension (file.<lang>.tftpl), this language is used as a data language. For example, in file.js.tftpl, JavaScript will be used. If the data language is not specified (for example, file.tftpl), the template file is recognized as plain text.

You can select a data language (or change the detected one) if you want the file syntax to be recognized accordingly.

1. Right-click the file tab in the editor and select Change <Language> template data language to, for example, Change JavaScript template data language to or Change Plain text template data language to.

   Alternatively, press Alt+Enter (Show Context Actions) in the file and select Choose template data language.

2. In the list of languages that opens, select the language.