IntenseWebs/opentofu
3
0
Fork 0
mirror of https://github.com/opentofu/opentofu.git synced 2025-02-25 18:45:20 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #31286 from BrianSidebotham/update_docs_for_30072

Browse Source 
Fixes #30072 - Update docs to show single file usage
This commit is contained in:
Laura Pacilio 2022-07-11 11:07:19 -04:00 committed by GitHub
commit 06baea9ae1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
internal/command/fmt.go
View File

@ -528,15 +528,18 @@ func (c *FmtCommand) trimNewlines(tokens hclwrite.Tokens) hclwrite.Tokens {
func (c *FmtCommand) Help() string {
helpText := `
Usage: terraform [global options] fmt [options] [DIR]
Usage: terraform [global options] fmt [options] [TARGET]
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.
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.
If TARGET is not specified, the command uses the current working directory.
If TARGET is a file, the command only uses the specified file. If TARGET
is "-" then the command reads from STDIN.
The content must be in the Terraform language native syntax; JSON is not
supported.
Options:

6
website/docs/cli/commands/fmt.mdx
View File

@ -45,12 +45,10 @@ and the generated files.
## Usage
Usage: `terraform fmt [options] [DIR]`
Usage: `terraform fmt [options] [TARGET]`
By default, `fmt` scans the current directory for configuration files. If
the `dir` argument is provided then it will scan that given directory
instead. If `dir` is a single dash (`-`) then `fmt` will read from standard
input (STDIN).
you provide a directory for the `target` argument, then `fmt` will scan that directory instead. If you provide a file, then `fmt` will process just that file. If you provide a single dash (`-`), then `fmt` will read from standard input (STDIN).
The command-line flags are all optional. The list of available flags are: