A VS Code extension for generating Terraform override files from existing GitHub public Terraform modules.
- Generate Terraform configuration files (provider.tf, main.tf, overrides.tf) from existing GitHub public Terraform modules
- Detect Terraform modules in public GitHub repositories with:
- Automatic module detection
- Variable extraction
- Request caching
- Error handling
- Integrated with VS Code's command palette
- Currently supports Terraform + AWS provider only
The extension specializes in detecting Terraform modules from public GitHub repositories with:
- Improved API request handling
- Better error messages
- More accurate variable detection
- Comprehensive test coverage
- Install the extension from the VS Code Marketplace
- Or load from the packaged .vsix file
- Open a Terraform file or workspace
- Run the "Generate TF Overrides" command from the command palette (Ctrl+Shift+P)
- Enter the GitHub Terraform module URL and AWS region when prompted
- Select variables to override and provide override values
- The extension generates provider.tf, main.tf, and overrides.tf files in your workspace
For a web-based interface to generate Terraform overrides, visit the TF Overrides Web App.
To contribute or run locally:
- Clone the repository
- Run
npm install - Run tests with
npm test
To build the extension locally and create a VSIX package:
- Ensure you have Node.js and npm installed
- Install vsce if not already installed:
npm install -g @vscode/vsce - Run the package command:
npx vsce package - This will generate a
.vsixfile (e.g.,tfoverrides-0.1.3.vsix) in the project root - You can install the VSIX file in VS Code via the Extensions view "Install from VSIX..." option
- VS Code 1.75.0 or higher
- Node.js 16.x or higher
- Internet access for GitHub API calls
- Uses Mocha as the test framework
- Tests run with ts-node for TypeScript support
- The 'vscode' module is mocked in tests for compatibility with Node.js environment and WSL