Add Terraform formatter step#959
Conversation
The step shells out to the external `terraform fmt` command, the implementation being similar to the existing Black step. This step is supposed to ensure consistent, conventional formatting for .tf and .tfvars files.
|
Looks great! I'm gonna give this 24 hrs in case anybody else has comments, then I'll merge and release. |
|
Actually, just one missing piece: the feature matrix in the root README. It's a bit tricky, the actual text of the table is rendered by an embedded freshmark script above it (edit the comment, run spotlessApply, and it will render the table), see this PR for an example. |
|
#949 looks interesting, doesn’t that mean instead of this entire PR we could use the native cmd capability instead for formatting terraform files? Must have overlooked this.. |
|
You are correct, another way to accomplish this PR would be to port |
|
I think having |
This PR adds the ability for Spotless to test for/enforce consistent formatting for Terraform files (.tf, .tfvars).
The step shells out to the external
terraform fmtcommand, the implementation being similar to the existingBlackstep.I found that often times terraform files are part of an application repository, thus enhancing Spotless in order to be able to use a single build tool/interface for keeping formatting for these sources consistent.
Here's a repository I used for doing integration testing of the gradle plugin: https://github.com/carhartl/spotless-terraform-test
See https://www.terraform.io/docs/cli/commands/fmt.html for more information regarding Terraform formatting.