terraform-fmt

terraform-fmt documentation

Version in MegaLinter: 1.4.6
Visit Official Web Site

Configuration in MegaLinter

Enable terraform-fmt by adding TERRAFORM_TERRAFORM_FMT in ENABLE_LINTERS variable
Disable terraform-fmt by adding TERRAFORM_TERRAFORM_FMT in DISABLE_LINTERS variable

Enable autofixes by adding TERRAFORM_TERRAFORM_FMT in APPLY_FIXES variable

Variable	Description	Default value
TERRAFORM_TERRAFORM_FMT_ARGUMENTS	User custom arguments to add in linter CLI call Ex: `-s --foo "bar"`
TERRAFORM_TERRAFORM_FMT_FILTER_REGEX_INCLUDE	Custom regex including filter Ex: `(src\\|lib)`	Include every file
TERRAFORM_TERRAFORM_FMT_FILTER_REGEX_EXCLUDE	Custom regex excluding filter Ex: `(test\\|examples)`	Exclude no file
TERRAFORM_TERRAFORM_FMT_CLI_LINT_MODE	Override default CLI lint mode - `file`: Calls the linter for each file - `project`: Call the linter from the root of the project	`file`
TERRAFORM_TERRAFORM_FMT_FILE_EXTENSIONS	Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files Ex: `[".py", ""]`	`[".tf"]`
TERRAFORM_TERRAFORM_FMT_FILE_NAMES_REGEX	File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]`	Include every file
TERRAFORM_TERRAFORM_FMT_PRE_COMMANDS	List of bash commands to run before the linter	None
TERRAFORM_TERRAFORM_FMT_POST_COMMANDS	List of bash commands to run after the linter	None
TERRAFORM_TERRAFORM_FMT_UNSECURED_ENV_VARIABLES	List of env variables explicitly not filtered before calling TERRAFORM_TERRAFORM_FMT and its pre/post commands	None
TERRAFORM_TERRAFORM_FMT_DISABLE_ERRORS	Run linter but consider errors as warnings	`true`
TERRAFORM_TERRAFORM_FMT_DISABLE_ERRORS_IF_LESS_THAN	Maximum number of errors allowed	`0`
TERRAFORM_TERRAFORM_FMT_CLI_EXECUTABLE	Override CLI executable	`['terraform']`

IDE Integration

Use terraform-fmt in your favorite IDE to catch errors before MegaLinter !

IDE	Extension Name	Install
Atom	terraform-fmt	Visit Web Site
IDEA	HashiCorp Terraform / HCL language support
Sublime Text	Terrafmt	Visit Web Site
Visual Studio Code	HashiCorp Terraform

MegaLinter Flavours

This linter is available in the following flavours

Flavor	Description	Embedded linters
all	Default MegaLinter Flavor	113
cupcake	MegaLinter for the most commonly used languages	81
terraform	Optimized for TERRAFORM based projects	51

Behind the scenes

How are identified applicable files

File extensions: .tf

How the linting is performed

terraform-fmt is called one time by identified file (file CLI lint mode)

Example calls

terraform fmt myfile.tf

Help content

Usage: terraform [global options] <subcommand> [args]

The available commands for execution are listed below.
The primary workflow commands are given first, followed by
less common or more advanced commands.

Main commands:
  init          Prepare your working directory for other commands
  validate      Check whether the configuration is valid
  plan          Show changes required by the current configuration
  apply         Create or update infrastructure
  destroy       Destroy previously-created infrastructure

All other commands:
  console       Try Terraform expressions at an interactive command prompt
  fmt           Reformat your configuration in the standard style
  force-unlock  Release a stuck lock on the current workspace
  get           Install or upgrade remote Terraform modules
  graph         Generate a Graphviz graph of the steps in an operation
  import        Associate existing infrastructure with a Terraform resource
  login         Obtain and save credentials for a remote host
  logout        Remove locally-stored credentials for a remote host
  metadata      Metadata related commands
  output        Show output values from your root module
  providers     Show the providers required for this configuration
  refresh       Update the state to match remote systems
  show          Show the current state or a saved plan
  state         Advanced state management
  taint         Mark a resource instance as not fully functional
  test          Experimental support for module integration testing
  untaint       Remove the 'tainted' state from a resource instance
  version       Show the current Terraform version
  workspace     Workspace management

Global options (use these before the subcommand, if any):
  -chdir=DIR    Switch to a different working directory before executing the
                given subcommand.
  -help         Show this help output, or the help for a specified subcommand.
  -version      An alias for the "version" subcommand.

Installation on mega-linter Docker image

Dockerfile commands :

FROM alpine/terragrunt:latest as terragrunt
COPY --link --from=terragrunt /bin/terraform /usr/bin/