6 Commits (36ff8b3c0273b5ae7563d25da53e2fd8ec61e893)

Author	SHA1	Message	Date
Dan Carley	64c1280951	command/fmt: Improve documentation for -diff and defaults (#6398) ... * command/fmt: Document -diff doesn't disable -write As noted in hashicorp/terraform#6343, this description misleadingly suggested that the `-diff` option disables the `-write` option. This isn't the case and because of the default options (described in c753390) the behaviour of `terraform fmt -diff` is actually the same as `terraform fmt -write -list -diff`. Replace the "instead of rewriting" description to clarify that. Documentation in hcl/fmtcmd is corrected in hashicorp/hcl#117 but it's not really necessary to bump the dependency version. * command/fmt: Show flag defaults in help text These were documented on the website but not in the `-help` text. This should help to clarify that you need to pass `-list=false -write=false -diff` if you only want to see diffs. Accordingly I've replaced the word "disabled" with "always false" in the STDIN special cases so that it matches the terminology used in the defaults and better indicates that it is overridden. NB: The 3x duplicated defaults and documentation makes me feel uneasy once again. I'm not sure how to solve that, though.	10 years ago
Dan Carley	79e2753e41	command/fmt: Disable list/write when using STDIN ... These options don't make sense when passing STDIN. `-write` will raise an error because there is no file to write to. `-list` will always say `<standard input>`. So disable whenever using STDIN, making the command much simpler: cat main.tf | terraform fmt -	10 years ago
Dan Carley	e9128769b5	command/fmt: Accept input from STDIN ... So that you can do automatic formatting from an editor. You probably want to disable the `-write` and `-list` options so that you just get the re-formatted content, e.g. cat main.tf | terraform fmt -write=false -list=false - I've added a non-exported field called `input` so that we can override this for the tests. If not specified, like in `commands.go`, then it will default to `os.Stdin` which works on the command line.	10 years ago
Dan Carley	1b967e612f	command/fmt: Accept optional directory argument ... So that you can operate on files in a directory other than your current working directory.	10 years ago
Dan Carley	c753390399	command/fmt: Default write and list to true ... The most common usage usage will be enabling the `-write` and `-list` options so that files are updated in place and a list of any modified files is printed. This matches the default behaviour of `go fmt` (not `gofmt`). So enable these options by default. This does mean that you will have to explicitly disable these if you want to generate valid patches, e.g. `terraform fmt -diff -write=false -list=false`	10 years ago
Dan Carley	cc41c7cfa0	command/fmt: Add new fmt command ... This uses the `fmtcmd` package which has recently been merged into HCL. Per the usage text, this rewrites Terraform config files to their canonical formatting and style. Some notes about the implementation for this initial commit: - all of the fmtcmd options are exposed as CLI flags - it operates on all files that have a `.tf` suffix - it currently only operates on the working directory and doesn't accept a directory argument, but I'll extend this in subsequent commits - output is proxied through `cli.UiWriter` so that we write in the same way as other commands and we can capture the output during tests - the test uses a very simple fixture just to ensure that it is working correctly end-to-end; the fmtcmd package has more exhaustive tests - we have to write the fixture to a file in a temporary directory because it will be modified and for this reason it was easier to define the fixture contents as a raw string	10 years ago