Terraform fmt for formatting - Commands & Configuration

Introduction

When you write Terraform code, it can get messy and hard to read. Terraform fmt helps by automatically fixing the layout and spacing so your code looks neat and consistent.

When you want to make your Terraform files easier to read for yourself and others.

Before sharing your Terraform code with teammates to keep a consistent style.

After editing Terraform files manually to fix any formatting issues.

When you want to avoid formatting mistakes that can cause confusion or errors.

Before committing Terraform code to version control to keep the repository clean.

Commands

This command formats all Terraform files in the current directory to follow the standard style.

Terminal

terraform fmt

Expected Output

No output (command runs silently)

This checks if any Terraform files need formatting without changing them. It helps you see if your code is already formatted correctly.

Terminal

terraform fmt -check

Expected Output

No output (command runs silently)

→

-check - Checks formatting without making changes

This formats Terraform files in the current directory and all subdirectories recursively.

Terminal

terraform fmt -recursive

Expected Output

No output (command runs silently)

→

-recursive - Formats files in all subfolders

Key Concept

If you remember nothing else from this pattern, remember: terraform fmt keeps your code clean and consistent automatically.

Common Mistakes

Not running terraform fmt before committing code

This causes inconsistent formatting that makes code harder to read and review.

Always run terraform fmt to format your files before committing.

Using terraform fmt without the -recursive flag in projects with subfolders

Only files in the current folder get formatted, leaving others messy.

Use terraform fmt -recursive to format all files in the project.

Ignoring terraform fmt -check output

You might miss that files need formatting and commit unformatted code.

Use terraform fmt -check in CI or before commits to catch unformatted files.

Summary

terraform fmt formats Terraform files to a standard style automatically.

Use terraform fmt -recursive to format files in all subdirectories.

Use terraform fmt -check to verify if files need formatting without changing them.

Practice

1. What is the main purpose of the terraform fmt command?

easy

A. To check for syntax errors in Terraform files

B. To deploy infrastructure to the cloud

C. To automatically format Terraform configuration files for readability

D. To destroy all Terraform-managed resources

Solution

1. Step 1: Understand the role of terraform fmt

   This command is designed to clean up and standardize the formatting of Terraform files, making them easier to read and maintain.

2. Step 2: Differentiate from other commands

   Unlike commands that deploy or destroy resources, terraform fmt only changes the file layout without affecting infrastructure.

3. Final Answer:

   To automatically format Terraform configuration files for readability -> Option C

4. Quick Check:

   Formatting = Readability [OK]

Hint: Remember: fmt = format code, not deploy or destroy [OK]

Common Mistakes:

• Confusing fmt with terraform apply
• Thinking fmt checks syntax errors
• Assuming fmt manages resources

2. Which of the following is the correct way to run terraform fmt on all files in the current directory?

easy

A. terraform fmt

B. terraform fmt -recursive

C. terraform fmt -all

D. terraform fmt --format-all

Solution

1. Step 1: Recall default behavior of terraform fmt

   By default, running terraform fmt without flags formats all Terraform files in the current directory.

2. Step 2: Check other options

   Options like -recursive exist to format subdirectories, but -all and --format-all are invalid flags.

3. Final Answer:

   terraform fmt -> Option A

4. Quick Check:

   Default fmt formats current directory [OK]

Hint: No flags needed to format current folder files [OK]

Common Mistakes:

• Using invalid flags like -all or --format-all
• Confusing recursive flag with default behavior
• Expecting fmt to format files outside current directory by default

3. Given this Terraform snippet before formatting:

resource "aws_instance" "example" {
ami = "ami-123456"
instance_type= "t2.micro"
}

What will terraform fmt do to this code?

medium

A. Add comments explaining each line

B. Add spaces around the equals sign and indent the block properly

C. Remove the resource block entirely

D. Change the resource type to "aws_server"

Solution

1. Step 1: Identify formatting issues

   The snippet lacks spaces around the equals sign and proper indentation inside the resource block.

2. Step 2: Understand what terraform fmt fixes

   It adds spaces around operators and indents blocks correctly but does not change resource types or add comments.

3. Final Answer:

   Add spaces around the equals sign and indent the block properly -> Option B

4. Quick Check:

   Fmt fixes spacing and indentation [OK]

Hint: Fmt fixes spacing and indentation, not content [OK]

Common Mistakes:

• Thinking fmt changes resource types
• Expecting fmt to add comments
• Assuming fmt deletes code blocks

4. You ran terraform fmt but your Terraform files still look messy. What is the most likely reason?

medium

A. Terraform fmt does not change file formatting

B. Terraform fmt only works on .tfvars files

C. Your files have syntax errors preventing formatting

D. You ran terraform fmt in the wrong directory

Solution

1. Step 1: Check where terraform fmt runs

   The command formats files in the current directory by default, so running it elsewhere won't affect your target files.

2. Step 2: Eliminate other options

   Terraform fmt does change formatting, works on .tf files, and does not require syntax correctness to format.

3. Final Answer:

   You ran terraform fmt in the wrong directory -> Option D

4. Quick Check:

   Run fmt where files are located [OK]

Hint: Run fmt in folder with your Terraform files [OK]

Common Mistakes:

• Assuming fmt fixes syntax errors
• Thinking fmt works on .tfvars files only
• Expecting fmt to format files outside current folder

5. You want to ensure all Terraform files in your project and all subfolders are formatted consistently before committing code. Which command should you use?

hard

A. terraform fmt -recursive

B. terraform fmt -all

C. terraform fmt --check

D. terraform fmt --init

Solution

1. Step 1: Understand recursive formatting

   The -recursive flag tells terraform fmt to format files in the current directory and all subdirectories.

2. Step 2: Review other options

   -all and --init are invalid flags; --check only verifies formatting without changing files.

3. Final Answer:

   terraform fmt -recursive -> Option A

4. Quick Check:

   Recursive flag formats all folders [OK]

Hint: Use -recursive to format all subfolders [OK]

Common Mistakes:

• Using invalid flags like -all
• Confusing --check with formatting action
• Trying to use --init for formatting