Allow terraform fmt to be run on a single file.

[ilanpillemer]

Current Terraform Version

v1.0.11

Use-cases

I would like to be able to run terraform fmt on a single file and not an entire directory. With all the same options.
For example terraform format -f main.tf, or terraform format -no-color -check -f main.tf

Attempted Solutions

Not possible.

Proposal

Usage: terraform [global options] fmt [options] [DIR]

	Rewrites all Terraform configuration files to a canonical format. Both
	configuration files (.tf) and variables files (.tfvars) are updated.
	JSON files (.tf.json or .tfvars.json) are not modified.

	If DIR is not specified then the current working directory will be used.
	If DIR is "-" then content will be read from STDIN. The given content must
	be in the Terraform language native syntax; JSON is not supported.

Options:

  -list=false    Don't list files whose formatting differs
                 (always disabled if using STDIN)

  -write=false   Don't write to source files
                 (always disabled if using STDIN or -check)

  -diff          Display diffs of formatting changes

  -check         Check if the input is formatted. Exit status will be 0 if all
                 input is properly formatted and non-zero otherwise.

  -f             If specified, file is used instead of every file in directory

  -no-color      If specified, output won't contain any color.

  -recursive     Also process files in subdirectories. By default, only the
                 given directory (or current directory) is processed.

References

No

[crw]

Thanks for this well-written report. The good news is that you can already specify a single filename in the place of DIR or - that will be formatted without impacting the rest of the folder. For example:

terraform fmt main.tf

will format only main.tf. I will keep this issue open as a documentation issue. If I have missed a detail or nuance in this request, please let me know. Thanks again!

[rubiagatra]

I would like to help, but where do I start @crw ?

Should I update to Usage: terraform [global options] fmt [options] [DIR|FILE] and all the documentation ?

[crw]

Thanks @rubiagatra, the answer is that I am not sure at the moment! I will update if and when I can provide clear guidance.

[github-actions]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.