Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sudokar/generator-tf-module
Project scaffolding for Terraform
https://github.com/sudokar/generator-tf-module
terraform terraform-generate terraform-generator terraform-scaffold
Last synced: 5 days ago
JSON representation
Project scaffolding for Terraform
- Host: GitHub
- URL: https://github.com/sudokar/generator-tf-module
- Owner: sudokar
- License: mit
- Created: 2019-03-10T12:31:37.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-02T11:39:33.000Z (6 months ago)
- Last Synced: 2024-09-19T00:26:04.172Z (about 2 months ago)
- Topics: terraform, terraform-generate, terraform-generator, terraform-scaffold
- Language: JavaScript
- Homepage: https://github.com/sudokar/generator-tf-module
- Size: 530 KB
- Stars: 261
- Watchers: 4
- Forks: 29
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-tf - Terraform Generator - Scaffolding for a new terraform module or project with support of test frameworks (terratest and kitchen-terraform) (Boilerplates / IDE)
- jimsghstars - sudokar/generator-tf-module - Project scaffolding for Terraform (JavaScript)
README
# Terraform module generator
[](https://www.npmjs.com/package/generator-tf-module) [](https://www.npmjs.com/package/generator-tf-module) [](https://hub.docker.com/r/sudokar/generator-tf-module) 
Scaffolding / Boilerplate generator for new Terraform module projects
## Features
- `main.tf`, `variables.tf`,`outputs.tf` files to module root path
- `.editorconfig`, `.gitignore`, `.gitattributes` and `.terraform-version` files to module root path
- Option to choose test framework
- [Terratest](https://github.com/gruntwork-io/terratest)
- [kitchen-terraform](https://github.com/newcontext-oss/kitchen-terraform)
- `test` directory with an example test based on test framework selection
- `.pre-commit-config.yaml` for `terraform fmt`, `terraform-docs`, `check-merge-conflict` and (`go fmt`, `golint`) / `rubocop`
- `example` directory with module usage tf files
## Prerequisites
- [terraform](https://learn.hashicorp.com/terraform/getting-started/install#installing-terraform) `pro tip: use tfenv`
- [terraform-docs](https://github.com/segmentio/terraform-docs)
- [pre-commit](https://pre-commit.com/#install)
- For tests
- **terratest**
- [golang](https://golang.org/doc/install#install) `pro tip: use gvm`
- [golint](https://github.com/golang/lint#installation)
- **kitchen-terraform**
- [ruby](https://rvm.io/) `pro tip: use rvm`
## Installation
- To use generator using Docker, Install [Docker](https://docs.docker.com/engine/install/) `recommended`
- To use generator using Nodejs, Install [nodejs](https://nodejs.org/en/download/) `pro tip: use nvm`
## Usage
To use the included generator execute the below command in shell and provide your answers to the prompts.
#### With Docker
For Terraform version 1
```sh
docker run --rm -it -v $(pwd):/generated -e myuid="$(id -u):$(id -g)" sudokar/generator-tf-module
```
For Terraform versions `0.15`, `0.14` and `0.13`
```sh
docker run --rm -it -v $(pwd):/generated -e myuid="$(id -u):$(id -g)" sudokar/generator-tf-module:0.9.0
```
#### With NodeJs
For Terraform version 1
```sh
npx -p yo -p generator-tf-module -c 'yo tf-module'
```
For Terraform versions `0.15`, `0.14` and `0.13`
```sh
npx -p yo -p [email protected] -c 'yo tf-module'
```
#### Prompts
```sh
...
? Enter name for the new terraform module : example-module
? Enter description for the new terraform module : Example terraform module
? Enter author name : sudokar
? Choose test framework (Use arrow keys)
❯ Terratest
kitchen-terraform
```
Project layout generated for the new module with _Terratest_ selection
```
example-module
├── .editorconfig
├── .gitattributes
├── .gitignore
├── .pre-commit-config.yaml
├── .terraform-version
├── README.md
├── main.tf
├── outputs.tf
├── variables.tf
├── example
│ ├── main.tf
│ ├── outputs.tf
│ └── variables.tf
├── test
└── example_test.go
```
Project layout generated for the new module with _kitchen-terraform_ selection
```
example-module
├── .editorconfig
├── .gitattributes
├── .gitignore
├── .pre-commit-config.yaml
├── .terraform-version
├── .ruby-version
├── .kitchen.yml
├── Gemfile
├── README.md
├── main.tf
├── outputs.tf
├── variables.tf
├── example
│ ├── main.tf
│ ├── outputs.tf
│ └── variables.tf
├── test
└── integration
└── default
└── example_spec.rb
```
#### Post generation steps
Step 1
On the generated module's root path, Initialize git repository
```sh
git init
```
Step 2
On the generated module's root path, Install pre-commit hooks
```sh
pre-commit install
```
Step 3 (Applicable only for `terratest`)
For golang tests, get below libs
```sh
go get github.com/gruntwork-io/terratest/modules/terraform
go get github.com/stretchr/testify/assert
```
## Contribution
Found a bug? feel free to raise an issue.
Pull requests are always welcome. Keen to review and merge asap.
## Support
Like the generator?
Click to 
Or, Add a star :star: to the repository
## Maintainer
This project is authored and maintained by [sudokar](https://github.com/sudokar)
## License
MIT