Skip to content

Commit

Permalink
Merge pull request #31286 from BrianSidebotham/update_docs_for_30072
Browse files Browse the repository at this point in the history
Fixes #30072 - Update docs to show single file usage
  • Loading branch information
laurapacilio committed Jul 11, 2022
2 parents a30d1c4 + a6aa759 commit 06baea9
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 11 deletions.
17 changes: 10 additions & 7 deletions internal/command/fmt.go
Expand Up @@ -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:
Expand Down
6 changes: 2 additions & 4 deletions website/docs/cli/commands/fmt.mdx
Expand Up @@ -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:

Expand Down

0 comments on commit 06baea9

Please sign in to comment.