@salte-common/terraflow 0.1.0-alpha.1

package/dist/templates/templates/application/typescript/test.template

@@ -0,0 +1,8 @@
+import { main } from '../main/index';
+
+describe('<project-name>', () => {
+  it('should run main function', () => {
+    expect(() => main()).not.toThrow();
+  });
+});
+

package/dist/templates/templates/application/typescript/tsconfig.json.template

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "commonjs",
+    "lib": ["ES2020"],
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true,
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}
+

package/dist/templates/templates/config/README.md.template

@@ -0,0 +1,82 @@
+# <project-name>
+
+Infrastructure as Code project managed with [Terraflow](https://github.com/salte-common/terraflow).
+
+## Prerequisites
+
+- [Terraform](https://www.terraform.io/downloads) >= 1.0
+- [Node.js](https://nodejs.org/) >= 18.x
+- [Terraflow](https://www.npmjs.com/package/terraflow): `npm install -g terraflow`
+- Cloud provider credentials (<provider>)
+
+## Getting Started
+
+1. Copy `.env.example` to `.env` and configure your credentials:
+   ```bash
+   cp .env.example .env
+   # Edit .env with your credentials
+   ```
+
+2. Review and update `.tfwconfig.yml` with your backend configuration
+
+3. Initialize Terraform:
+   ```bash
+   terraflow init
+   ```
+
+4. Plan your infrastructure:
+   ```bash
+   terraflow plan
+   ```
+
+5. Apply your infrastructure:
+   ```bash
+   terraflow apply
+   ```
+
+## Project Structure
+
+- `src/` - Application source code
+  - `main/` - Main application code
+  - `test/` - Test files
+- `terraform/` - Infrastructure as Code
+  - `modules/` - Reusable Terraform modules
+  - `_init.tf` - Provider and backend configuration
+  - `*.tf` - Main terraform configuration
+- `.tfwconfig.yml` - Terraflow configuration
+- `.env` - Local environment variables (not committed)
+
+## Terraflow Commands
+
+```bash
+# Initialize terraform and workspace
+terraflow init
+
+# Plan changes
+terraflow plan
+
+# Apply changes
+terraflow apply
+
+# Destroy infrastructure
+terraflow destroy
+
+# Show current configuration
+terraflow config show
+```
+
+## Workspace Management
+
+Terraflow automatically derives workspace names from your git branch:
+- Main branch → `main` workspace
+- Feature branches (e.g., `feature/new-api`) → hostname-based workspace
+- Can be overridden with `--workspace` flag
+
+## Configuration
+
+See `.tfwconfig.yml` for all available options and the [documentation](https://github.com/salte-common/terraflow/blob/main/docs/configuration.md) for detailed configuration reference.
+
+## License
+
+MIT
+

package/dist/templates/templates/config/env.example.template

@@ -0,0 +1,22 @@
+# AWS Credentials (for S3 backend and AWS provider)
+# AWS_ACCESS_KEY_ID=your_access_key
+# AWS_SECRET_ACCESS_KEY=your_secret_key
+# AWS_REGION=us-east-1
+
+# Azure Credentials (for Azure backend and provider)
+# ARM_CLIENT_ID=your_client_id
+# ARM_CLIENT_SECRET=your_client_secret
+# ARM_SUBSCRIPTION_ID=your_subscription_id
+# ARM_TENANT_ID=your_tenant_id
+
+# GCP Credentials (for GCS backend and GCP provider)
+# GOOGLE_APPLICATION_CREDENTIALS=/path/to/key.json
+# GCP_PROJECT_ID=your-project-id
+
+# Terraflow Configuration
+# TERRAFLOW_WORKSPACE=development
+# TERRAFLOW_SKIP_COMMIT_CHECK=false
+
+# Terraform Variables (TF_VAR_*)
+# TF_VAR_environment=development
+

package/dist/templates/templates/config/gitignore.template

@@ -0,0 +1,40 @@
+# Terraform
+**/.terraform/*
+*.tfstate
+*.tfstate.*
+*.tfvars
+.terraform.lock.hcl
+
+# Terraflow
+.terraflow/
+
+# Environment
+.env
+
+# Language-specific (adjust based on --language)
+# Node.js:
+node_modules/
+npm-debug.log*
+dist/
+
+# Python:
+__pycache__/
+*.py[cod]
+venv/
+.pytest_cache/
+*.egg-info/
+
+# Go:
+*.exe
+*.dll
+*.so
+*.dylib
+vendor/
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+.DS_Store
+

package/dist/templates/templates/config/tfwconfig.yml.template

@@ -0,0 +1,69 @@
+# Terraflow configuration
+# See: https://github.com/salte-common/terraflow/blob/main/docs/configuration.md
+
+# Working directory for terraform files
+working-dir: ./terraform
+
+# Workspace derivation strategy
+workspace_strategy:
+  - cli
+  - env
+  - tag
+  - branch
+  - hostname
+
+# Backend configuration (adjust for your provider)
+backend:
+  type: <provider>  # local, s3, azurerm, or gcs
+  config:
+    # Template variables are supported: ${VAR_NAME}
+    # See documentation for available template variables
+    
+    # Uncomment and configure based on your provider:
+    
+    # AWS S3 Backend:
+    # bucket: ${AWS_REGION}-${AWS_ACCOUNT_ID}-terraform-state
+    # key: ${GITHUB_REPOSITORY}
+    # region: ${AWS_REGION}
+    # dynamodb_table: terraform-statelock
+    # encrypt: true
+    
+    # Azure Backend:
+    # storage_account_name: mystorageaccount
+    # container_name: tfstate
+    # key: terraform.tfstate
+    
+    # GCP Backend:
+    # bucket: my-gcs-bucket
+    # prefix: terraform/state
+
+# Uncomment to configure secrets from secret manager
+# secrets:
+#   provider: env  # env | aws-secrets | azure-keyvault | gcp-secret-manager
+#   config:
+#     # AWS Secrets Manager:
+#     # region: us-east-1
+#     # secret_name: <project-name>/terraform-vars
+#     
+#     # Azure Key Vault:
+#     # vault_name: my-keyvault
+#     
+#     # GCP Secret Manager:
+#     # project_id: my-project
+
+# Terraform variables
+variables:
+  environment: development
+
+# Validations
+validations:
+  require_git_commit: true
+  # allowed_workspaces:
+  #   - development
+  #   - staging
+  #   - production
+
+# Logging
+logging:
+  level: info
+

package/dist/templates/templates/terraform/aws/_init.tf.template

@@ -0,0 +1,24 @@
+terraform {
+  required_version = ">= 1.0"
+  
+  required_providers {
+    aws = {
+      source  = "hashicorp/aws"
+      version = "~> 5.0"
+    }
+  }
+  
+  backend "s3" {
+    # Backend configuration provided via:
+    # - terraflow CLI flags
+    # - environment variables (TERRAFLOW_*)
+    # - .tfwconfig.yml
+    # 
+    # Do not hardcode values here
+  }
+}
+
+provider "aws" {
+  region = var.aws_region
+}
+

package/dist/templates/templates/terraform/aws/inputs.tf.template

@@ -0,0 +1,11 @@
+variable "aws_region" {
+  description = "AWS region for resources"
+  type        = string
+  default     = "us-east-1"
+}
+
+variable "environment" {
+  description = "Environment name (e.g., dev, staging, prod)"
+  type        = string
+}
+

package/dist/templates/templates/terraform/azure/_init.tf.template

@@ -0,0 +1,19 @@
+terraform {
+  required_version = ">= 1.0"
+  
+  required_providers {
+    azurerm = {
+      source  = "hashicorp/azurerm"
+      version = "~> 3.0"
+    }
+  }
+  
+  backend "azurerm" {
+    # Backend configuration provided via terraflow
+  }
+}
+
+provider "azurerm" {
+  features {}
+}
+

package/dist/templates/templates/terraform/azure/inputs.tf.template

@@ -0,0 +1,11 @@
+variable "azure_location" {
+  description = "Azure region for resources"
+  type        = string
+  default     = "eastus"
+}
+
+variable "environment" {
+  description = "Environment name"
+  type        = string
+}
+

package/dist/templates/templates/terraform/gcp/_init.tf.template

@@ -0,0 +1,20 @@
+terraform {
+  required_version = ">= 1.0"
+  
+  required_providers {
+    google = {
+      source  = "hashicorp/google"
+      version = "~> 5.0"
+    }
+  }
+  
+  backend "gcs" {
+    # Backend configuration provided via terraflow
+  }
+}
+
+provider "google" {
+  project = var.gcp_project_id
+  region  = var.gcp_region
+}
+

package/dist/templates/templates/terraform/gcp/inputs.tf.template

@@ -0,0 +1,16 @@
+variable "gcp_project_id" {
+  description = "GCP project ID"
+  type        = string
+}
+
+variable "gcp_region" {
+  description = "GCP region for resources"
+  type        = string
+  default     = "us-central1"
+}
+
+variable "environment" {
+  description = "Environment name"
+  type        = string
+}
+

package/dist/templates/templates/terraform/locals.tf.template

@@ -0,0 +1,9 @@
+locals {
+  # Common tags/labels for all resources
+  common_tags = {
+    Environment = var.environment
+    ManagedBy   = "terraform"
+    Project     = "<project-name>"
+  }
+}
+

package/dist/templates/templates/terraform/main.tf.template

@@ -0,0 +1,8 @@
+# Main infrastructure resources go here
+# Example module usage:
+# module "example" {
+#   source = "./modules"
+#   
+#   environment = var.environment
+# }
+

package/dist/templates/templates/terraform/modules/inputs.tf.template

@@ -0,0 +1,5 @@
+variable "environment" {
+  description = "Environment name"
+  type        = string
+}
+

package/dist/templates/templates/terraform/modules/main.tf.template

@@ -0,0 +1,2 @@
+# Module resources go here
+

package/dist/templates/templates/terraform/modules/outputs.tf.template

@@ -0,0 +1,2 @@
+# Module outputs go here
+

package/dist/templates/templates/terraform/outputs.tf.template

@@ -0,0 +1,6 @@
+# Output values from your infrastructure
+# output "example_output" {
+#   description = "Example output description"
+#   value       = module.example.output_value
+# }
+

package/dist/templates/terraform/aws/_init.tf.template

@@ -0,0 +1,24 @@
+terraform {
+  required_version = ">= 1.0"
+  
+  required_providers {
+    aws = {
+      source  = "hashicorp/aws"
+      version = "~> 5.0"
+    }
+  }
+  
+  backend "s3" {
+    # Backend configuration provided via:
+    # - terraflow CLI flags
+    # - environment variables (TERRAFLOW_*)
+    # - .tfwconfig.yml
+    # 
+    # Do not hardcode values here
+  }
+}
+
+provider "aws" {
+  region = var.aws_region
+}
+

package/dist/templates/terraform/aws/inputs.tf.template

@@ -0,0 +1,11 @@
+variable "aws_region" {
+  description = "AWS region for resources"
+  type        = string
+  default     = "us-east-1"
+}
+
+variable "environment" {
+  description = "Environment name (e.g., dev, staging, prod)"
+  type        = string
+}
+

package/dist/templates/terraform/azure/_init.tf.template

@@ -0,0 +1,19 @@
+terraform {
+  required_version = ">= 1.0"
+  
+  required_providers {
+    azurerm = {
+      source  = "hashicorp/azurerm"
+      version = "~> 3.0"
+    }
+  }
+  
+  backend "azurerm" {
+    # Backend configuration provided via terraflow
+  }
+}
+
+provider "azurerm" {
+  features {}
+}
+

package/dist/templates/terraform/azure/inputs.tf.template

@@ -0,0 +1,11 @@
+variable "azure_location" {
+  description = "Azure region for resources"
+  type        = string
+  default     = "eastus"
+}
+
+variable "environment" {
+  description = "Environment name"
+  type        = string
+}
+

package/dist/templates/terraform/gcp/_init.tf.template

@@ -0,0 +1,20 @@
+terraform {
+  required_version = ">= 1.0"
+  
+  required_providers {
+    google = {
+      source  = "hashicorp/google"
+      version = "~> 5.0"
+    }
+  }
+  
+  backend "gcs" {
+    # Backend configuration provided via terraflow
+  }
+}
+
+provider "google" {
+  project = var.gcp_project_id
+  region  = var.gcp_region
+}
+

package/dist/templates/terraform/gcp/inputs.tf.template

@@ -0,0 +1,16 @@
+variable "gcp_project_id" {
+  description = "GCP project ID"
+  type        = string
+}
+
+variable "gcp_region" {
+  description = "GCP region for resources"
+  type        = string
+  default     = "us-central1"
+}
+
+variable "environment" {
+  description = "Environment name"
+  type        = string
+}
+

package/dist/templates/terraform/locals.tf.template

@@ -0,0 +1,9 @@
+locals {
+  # Common tags/labels for all resources
+  common_tags = {
+    Environment = var.environment
+    ManagedBy   = "terraform"
+    Project     = "<project-name>"
+  }
+}
+

package/dist/templates/terraform/main.tf.template

@@ -0,0 +1,8 @@
+# Main infrastructure resources go here
+# Example module usage:
+# module "example" {
+#   source = "./modules"
+#   
+#   environment = var.environment
+# }
+

package/dist/templates/terraform/modules/inputs.tf.template

@@ -0,0 +1,5 @@
+variable "environment" {
+  description = "Environment name"
+  type        = string
+}
+

package/dist/templates/terraform/modules/main.tf.template

@@ -0,0 +1,2 @@
+# Module resources go here
+

package/dist/templates/terraform/modules/outputs.tf.template

@@ -0,0 +1,2 @@
+# Module outputs go here
+

package/dist/templates/terraform/outputs.tf.template

@@ -0,0 +1,6 @@
+# Output values from your infrastructure
+# output "example_output" {
+#   description = "Example output description"
+#   value       = module.example.output_value
+# }
+

package/dist/types/config.d.ts

@@ -0,0 +1,92 @@
+/**
+ * Configuration type definitions for Terraflow CLI
+ */
+/**
+ * Backend configuration
+ */
+export interface BackendConfig {
+    /** Backend type: local | s3 | azurerm | gcs */
+    type: string;
+    /** Backend-specific configuration */
+    config?: Record<string, unknown>;
+}
+/**
+ * Secrets provider configuration
+ */
+export interface SecretsConfig {
+    /** Secrets provider type: env | aws-secrets | azure-keyvault | gcp-secret-manager */
+    provider: string;
+    /** Provider-specific configuration */
+    config?: Record<string, unknown>;
+}
+/**
+ * Authentication configuration
+ */
+export interface AuthConfig {
+    /** AWS assume role configuration */
+    assume_role?: {
+        role_arn: string;
+        session_name?: string;
+        duration?: number;
+    };
+    /** Azure service principal configuration */
+    service_principal?: {
+        client_id: string;
+        tenant_id: string;
+        client_secret?: string;
+    };
+    /** GCP service account configuration */
+    service_account?: {
+        key_file: string;
+    };
+}
+/**
+ * Workspace derivation strategy
+ */
+export type WorkspaceStrategy = 'cli' | 'env' | 'tag' | 'branch' | 'hostname';
+/**
+ * Logging configuration
+ */
+export interface LoggingConfig {
+    /** Log level: error | warn | info | debug */
+    level: 'error' | 'warn' | 'info' | 'debug';
+    /** Enable Terraform log output */
+    terraform_log?: boolean;
+    /** Terraform log level */
+    terraform_log_level?: 'TRACE' | 'DEBUG' | 'INFO' | 'WARN' | 'ERROR';
+}
+/**
+ * Validation configuration
+ */
+export interface ValidationConfig {
+    /** Require git commit before apply/destroy */
+    require_git_commit?: boolean;
+    /** List of allowed workspace names (empty = allow all) */
+    allowed_workspaces?: string[];
+}
+/**
+ * Main Terraflow configuration file structure
+ */
+export interface TerraflowConfig {
+    /** Workspace name */
+    workspace?: string;
+    /** Terraform working directory */
+    'working-dir'?: string;
+    /** Skip git commit check */
+    'skip-commit-check'?: boolean;
+    /** Backend configuration */
+    backend?: BackendConfig;
+    /** Secrets management configuration */
+    secrets?: SecretsConfig;
+    /** Authentication configuration */
+    auth?: AuthConfig;
+    /** Terraform variables */
+    variables?: Record<string, unknown>;
+    /** Workspace derivation strategy */
+    workspace_strategy?: WorkspaceStrategy[];
+    /** Validation configuration */
+    validations?: ValidationConfig;
+    /** Logging configuration */
+    logging?: LoggingConfig;
+}
+//# sourceMappingURL=config.d.ts.map

package/dist/types/config.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+ * Configuration type definitions for Terraflow CLI
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=config.js.map