From 99e805c70816c5fefa41580d5d094f36d3672fc9 Mon Sep 17 00:00:00 2001 From: Brian Sidebotham Date: Tue, 21 Jun 2022 13:54:44 +0100 Subject: [PATCH] Fixes #30072 - Update documentation to show that the old DIR option can target a single file instead --- internal/command/fmt.go | 9 +++++---- website/docs/cli/commands/fmt.mdx | 9 +++++---- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/internal/command/fmt.go b/internal/command/fmt.go index 625e69326b5e..aff52e9d5f73 100644 --- a/internal/command/fmt.go +++ b/internal/command/fmt.go @@ -528,15 +528,16 @@ 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. - 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 then the current working directory will be + used. If TARGET is a file, only that file will be used. If TARGET is + "-" then content will be read from STDIN. The given content must be in + the Terraform language native syntax; JSON is not supported. Options: diff --git a/website/docs/cli/commands/fmt.mdx b/website/docs/cli/commands/fmt.mdx index c6868d733f9f..4279eb182fed 100644 --- a/website/docs/cli/commands/fmt.mdx +++ b/website/docs/cli/commands/fmt.mdx @@ -45,12 +45,13 @@ 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). +a directory is provided for the `target` argument then it will scan that +given directory instead. If `target` is a file then `fmt` will process just +that file, and if a single dash (`-`) then `fmt` will read from standard input +(STDIN). The command-line flags are all optional. The list of available flags are: