Question 1

How do I run generator-tf-module without Docker?

Accepted Answer

You can use it with Node.js by running npx -p yo -p generator-tf-module -c 'yo tf-module'. Ensure you have Node.js and Yeoman installed locally, as per the README's installation section.

Question 2

What's the difference between Terratest and kitchen-terraform in this generator?

Accepted Answer

Terratest is Go-based and requires Go installation, while kitchen-terraform is Ruby-based and needs Ruby. The generator provides example tests for both, so choose based on your team's expertise and existing tooling.

Question 3

Can I customize the generated Terraform files?

Accepted Answer

Yes, after generation, you can edit all files like main.tf or variables.tf. However, the generator itself doesn't offer customization options during the prompt phase, so modifications must be done manually post-scaffolding.

Question 4

Is generator-tf-module better than using terraform init for modules?

Accepted Answer

terraform init initializes a working directory for Terraform configurations, but it doesn't scaffold module structures. generator-tf-module is specifically designed to create standardized module layouts with testing and automation, making it more suitable for module development best practices.

Question 5

How to add my own pre-commit hooks to the generated config?

Accepted Answer

After generation, you can edit the .pre-commit-config.yaml file to add custom hooks. The generator sets up a base configuration with hooks like terraform fmt, which you can extend by following pre-commit documentation.

Question 6

Does this work with Terraform 0.12?

Accepted Answer

The README specifies support for Terraform versions 0.13, 0.14, 0.15, and 1.x. For Terraform 0.12, you might need to check if an older version of the generator is compatible or manually adjust the generated files, as it's not explicitly supported.

Terraform Generator

What is Terraform Generator?

Overview

Use Cases

Best For

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions