generator-terraform-module
Advanced tools
Yeoman helps you to kickstart new projects, prescribing best practices and tools to help you stay productive
In order to run this generator, you will need the following:
To install Yeoman, run the following command in your console:
npm install -g yo bower grunt-cli
This will make Yeoman (via yo) as well as the base dependencies of Yeoman, namely Bower and Grunt available.
Note that you might require sudo permissions to install the above modules globally.
To install this generator, run the following command in your console:
npm install -g generator-terraform-module
Alternatively, you can install the generator directly from Git HEAD by running the following command:
npm install -g https://bitbucket.org/cultivatedops/generator-terraform-module/get/HEAD.tar.gz
In order to run the included generator, open a console (Terminal.app, PuTTY) and change into the directory you want to generate the module in. Then, run the following command:
yo terraform-module
Should the above command fail, verify that Yeoman does indeed see the generator by executing yo and looking for an entry named "Terraform Module".
On an initial run, you will be asked to provide your full name and email address. These values will be stored for future use.
After all questions have been answered, Yeoman will generate the scaffolding needed to kickstart a Terraform module.
The layout for a generated module will look like so:
.
├── .editorconfig
├── .gitignore
├── .release.json
├── README.md
├── main.tf
├── output.tf
└── variables.tf
The .release.json file is optional and will only be created when Release It! support is enabled during the generation.
The files will be placed in a directory containing the name you provided for the module, prefixed by terraform-module-.
The following animation shows how the generator looks like, in action:
This generator is currently maintained by the individuals listed below:
This generator was sponsored by the individuals and companies listed below:
generator-terraform-module is licensed under the Apache 2.0 license. A full copy of the license can be found on the apache.org site.
In short, this license permits you to use this product commercially, distribute this software and make modifications.
The software is provided without warranty and any contributors cannot be held liable for damages. You are also not allowed to use any name, logo or trademark without prior consent.
FAQs
Scaffolding for your Terraform Module
The npm package generator-terraform-module receives a total of 4 weekly downloads. As such, generator-terraform-module popularity was classified as not popular.
We found that generator-terraform-module demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Snyk's use of malicious npm packages for research raises ethical concerns, highlighting risks in public deployment, data exfiltration, and unauthorized testing.
Research
Security News
Socket researchers found several malicious npm packages typosquatting Chalk and Chokidar, targeting Node.js developers with kill switches and data theft.
Security News
pnpm 10 blocks lifecycle scripts by default to improve security, addressing supply chain attack risks but sparking debate over compatibility and workflow changes.