Agent Skills
返回列表
💻

Terraform 模块脚手架生成器

开发编程 更新于 2026.08.29

将以下提示词粘贴到你的 AI 对话框中：

请根据 https://skillhub.cn/install/skillhub.md，安装 @user_3c6cb52e/terraform-module-scaffold-generator 到 AI 助手中。

技能介绍

问题背景

手动创建 Terraform 模块脚手架时，常遇到文件结构不统一的问题——有的模块缺少规范的变量定义，有的对象输出与资源声明混在一起，后期维护时需要反复调整格式。尤其多人协作时，variables.tf、outputs.tf 和 provider 配置的标准不一致，会增加代码评审的沟通成本。此外，模块文档需要手动编写，常出现与实际配置脱节的情况，新成员上手时需要反复对照代码理解参数含义。

核心能力

  • 基于 HashiCorp Configuration Language（HCL）生成标准化脚手架，包含 variables.tf、outputs.tf 和预定义的 provider 配置块，确保模块结构符合 Terraform 最佳实践
  • 集成 terraform-docs 工具，根据变量、输出和资源自动生成 README 文档，减少手动维护文档的时间成本
  • 自动包含预配置的 .terraform-version 文件，方便在开发环境中统一 Terraform 版本
  • 生成的脚手架支持通过变量定义模块接口，输出关键资源属性，可直接用于云资源封装或内部工具开发

适用边界

  • 仅生成模块基础结构，不包含具体资源（如 AWS EC2、S3）的实现逻辑，需要开发者自行填充资源代码
  • 依赖本地已安装 terraform-docs 工具，未安装时文档生成步骤会中断
  • 适合标准化模块开发，针对特定云厂商的定制化需求（如 Azure 资源命名规范）需要额外调整
  • 生成的配置需配合 Terraform 命令（如 terraform init）验证有效性，复杂场景可能需要补充测试用例

使用场景

  • 在构建可复用 Terraform 模块时，需要快速生成 variables.tf、outputs.tf 和 provider 配置的基础结构。
  • 团队要封装云资源模块，需要通过 terraform-docs 自动生成与代码一致的 README 文档。
  • 多人协作开发模块时，需要统一 .terraform-version 文件以保证开发环境版本一致。
  • 为新项目创建 Terraform 模块仓库，需要符合 HashiCorp 最佳实践的初始文件组织。

适合人员

  • 云平台工程师：需要为不同云资源封装标准化 Terraform 模块，减少重复配置。
  • 基础设施开发者：希望快速生成模块基础结构，避免手动创建 variables.tf 和 outputs.tf。
  • DevOps 工具链维护者：需要确保模块文档与代码自动同步，降低维护成本。
  • 后端工程师：在部署云资源时，需要符合规范的模块脚手架来集成到 CI/CD 流程。