https://github.com/apparentlymart/terraform-clean-syntax

A simple tool for Terraform language syntax cleanup, extending terraform fmt
https://github.com/apparentlymart/terraform-clean-syntax

Last synced: about 1 month ago
JSON representation

A simple tool for Terraform language syntax cleanup, extending terraform fmt

• Host: GitHub
• URL: https://github.com/apparentlymart/terraform-clean-syntax
• Owner: apparentlymart
• License: mpl-2.0
• Archived: true
• Created: 2019-11-20T01:42:23.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2020-10-24T23:50:19.000Z (about 4 years ago)
• Last Synced: 2024-08-05T08:08:31.594Z (5 months ago)
• Language: Go
• Size: 26.4 KB
• Stars: 160
• Watchers: 7
• Forks: 24
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# `terraform-clean-syntax`

> **NOTE:** The changes made by this tool were integrated into Terraform's own `terraform fmt` in Terraform v0.14.0, so the functionality in this repository will see no further changes.

`terraform-clean-syntax` is a simple command line tool for performing some

small syntax cleanup steps on Terraform `.tf` configuration files

automatically.

Specifically, it currently knows how to clean up the following:

* Argument values that are just a single template interpolation, like

  `"${foo}"`, are simplified to the equivalent `foo`.

* Variable type constraints using the legacy forms from Terraform 0.11, like

  `"string"`, `"list"`, or `"map"`, are replaced with their modern type

  constraint expressions `string`, `list(string)` and `map(string)`.

The two changes listed above will both silence some (though not all) of the

syntax deprecation warnings emitted by Terraform 0.12.14 and later. This program

is conservative, so it may skip certain opportunities for cleanup if they are

too complex for it to be sure that the change is safe.

The built in `terraform fmt` command in Terraform doesn't perform these cleanups

automatically at the time of writing, because the Terraform team worried that

this would make it difficult for folks to continue maintaining modules that

are cross-compatible with both Terraform 0.11 and 0.12. The cleanups made by

this program will render a configuration incompatible with Terraform 0.11,

so this program should not be used on any module that must retain Terraform 0.11

compatibility.

## Usage

After compiling the program using Go 1.12 or later, run it with a single

argument that is a file or directory to apply rewriting to:

```

terraform-clean-syntax .

```

If given a directory, `terraform-clean-syntax` will visit all of the `.tf`

files in the directory and recursively search any directories within it.

If given a single file, `terraform-clean-syntax` will process that file only

if its name has the suffix `.tf`.

This program rewrites configuration files in-place, so it's best to make sure

your version control work tree is clean before running so that you can clearly

see which changes it is proposing and discard those changes if desired.

This program is a best-effort static analysis tool and it doesn't have intimate

understanding of Terraform language syntax, so be sure to review the changes it

proposes and test your resulting configuration with `terraform validate` and/or

`terraform plan` before merging the changes into your codebase.