1.6.7.1. fmt

terraform fmt命令被用来格式化Terraform代码文件的格式和规范。该命令会对代码文件应用我们之前介绍过的代码风格规范中的一些规定,另外会针对可读性对代码做些微调整。

其他具有生成Terraform代码文件功能的命令会按照terraform fmt的标准来生成代码,所以请在项目中遵循fmt的代码风格以保持代码风格的统一。

Terraform不同版本的代码风格规范会有些微不同,所以在升级Terraform后我们建议要对代码执行一次terraform fmt。

1.6.7.1.1. 用法

terraform fmt [options] [dir]

默认情况下,fmt会扫描当前文件夹以寻找代码文件。如果dir参数被提供了,那么它会扫描dir指向的目录。如果dir参数是一个减号(-),那么fmt命令会从标准输入中读取(STDIN)。

该命令支持以下参数:

  • -list=false:不列出包含不一致风格的文件
  • -write=false:不要重写输入文件(通过-check参数实现,或是使用标准输入流时)
  • -diff:展示格式差异
  • -check:检查输入是否合规。返回0则代表所有输入的代码风格都是合规,反之则不是0
  • -recursive:是否递归处理所有子文件夹。默认情况下为false(只有当前文件夹会被处理,不涉及内嵌子模块)

results matching ""

    No results matching ""