Skip to content

Latest commit

 

History

History
340 lines (256 loc) · 7.04 KB

template-variables.md

File metadata and controls

340 lines (256 loc) · 7.04 KB

Template Variables

Template variables allow you to create dynamic content in your StructKit configurations. This page covers all aspects of working with variables.

Custom Delimiters (StructKit)

StructKit uses custom Jinja2 delimiters to avoid conflicts with YAML and other content:

  • Variables: {{@ and @}}
  • Blocks: {%@ and @%}
  • Comments: {#@ and @#}

Examples are shown below and throughout this page.

Basic Syntax

Use template variables by enclosing them in {{@ and @}}:

files:
  - README.md:
      content: |
        # {{@ project_name @}}
        Welcome to {{@ project_name @}}!

Block Syntax

For control structures, use block notation:

  • Start block: {%@
  • End block: %@}
files:
  - config.yaml:
      content: |
        {%@ if environment == "production" @%}
        debug: false
        {%@ else @%}
        debug: true
        {%@ endif @%}

Comments

Use comment notation to document your templates:

  • Start comment: {#@
  • End comment: @#}
files:
  - app.py:
      content: |
        {#@ This is a template comment @#}
        app_name = "{{@ project_name @}}"

Default Variables

StructKit provides these built-in variables:

  • file_name: The name of the file being processed
  • file_directory: The directory containing the file being processed

Interactive Variables

Define variables that prompt users for input. When running in interactive mode, StructKit will display the variable's description to help users understand what value is expected:

variables:
  - project_name:
      description: "The name of your project"
      type: string
      default: "MyProject"
  - author_name:
      description: "Your name"
      type: string
      # No default = interactive prompt
  - port:
      description: "Application port"
      type: integer
      default: 8080

When prompted interactively, variables with descriptions will display with contextual icons, bold variable names, and clean formatting:

🚀 project_name: The name of your project
   Enter value [MyProject]:

🌍 environment: Target deployment environment
   Options: (1) dev, (2) staging, (3) prod
   Enter value [dev]:

For variables without descriptions, a more compact format is used:

🔧 author_name []:
⚡ enable_logging [true]:

Note: Variable names appear in bold in actual terminal output for better readability.

Contextual Icons: StructKit automatically selects appropriate icons based on variable names and types:

  • 🚀 Project/app names
  • 🌍 Environment/deployment variables
  • 🔌 Ports/network settings
  • 🗄️ Database configurations
  • ⚡ Boolean/toggle options
  • 🔐 Authentication/secrets
  • 🏷️ Versions/tags
  • 📁 Paths/directories
  • 🔧 General variables

Note: The description field is displayed in interactive mode only. You can also use the legacy help field which works the same way.

Variable Types

  • string: Text values
  • integer: Numeric values
  • number: Floating-point values
  • boolean: True/false values

Validation and Defaults

Interactive enum selection: when a variable defines enum and you are in interactive mode, StructKit will display numbered choices and accept either the number or the exact value. Press Enter to accept the default (if any).

Example prompt:

❓ Enter value for ENV [dev] (1) dev, (2) prod:
# Typing `2` selects `prod`, typing `prod` also works.

You can now enforce types and validations in your variables schema:

  • required: true to require a value (non-interactive runs will error if missing)
  • enum: [...] to restrict values to a set
  • regex/pattern to validate string format
  • min/max to bound numeric values
  • env or default_from_env to set defaults from environment variables

Example:

variables:
  - IS_ENABLED:
      type: boolean
      required: true
  - RETRY:
      type: integer
      min: 1
      max: 5
  - ENV:
      type: string
      enum: [dev, prod]
  - TOKEN:
      type: string
      env: MY_TOKEN

Custom Jinja2 Filters and Globals

StructKit includes custom filters for common tasks:

uuid() (global)

Generate a random UUID v4 string.

files:
  - id.txt:
      content: |
        id: {{@ uuid() @}}

now() (global)

Return the current UTC time in ISO 8601 format.

files:
  - stamp.txt:
      content: |
        generated_at: {{@ now() @}}

env(name, default="") (global)

Read an environment variable with an optional default.

files:
  - .env.example:
      content: |
        TOKEN={{@ env("TOKEN", "changeme") @}}

read_file(path) (global)

Read the contents of a file on disk. Returns empty string on error.

files:
  - README.md:
      content: |
        {{@ read_file("INTRO.md") @}}

to_yaml / from_yaml (filters)

Serialize and parse YAML.

files:
  - data.yml:
      content: |
        {{@ some_dict | to_yaml @}}
# Assume str_var holds YAML string
{%@ set obj = str_var | from_yaml @%}

to_json / from_json (filters)

Serialize and parse JSON.

files:
  - data.json:
      content: |
        {{@ some_dict | to_json @}}
# Assume str_var holds JSON string
{%@ set obj = str_var | from_json @%}

latest_release

Fetch the latest release version from GitHub:

files:
  - Dockerfile:
      content: |
        FROM node:{{@ "nodejs/node" | latest_release @}}

Requirements: Set GITHUB_TOKEN environment variable for private repos.

slugify

Convert strings to URL-friendly slugs:

files:
  - "{{@ project_name | slugify @}}.conf":
      content: |
        server_name {{@ project_name | slugify @}};

Options: Optional separator character (default: -)

default_branch

Get the default branch name of a GitHub repository:

files:
  - .github/workflows/ci.yml:
      content: |
        on:
          push:
            branches: [ {{@ "httpdss/struct" | default_branch @}} ]

The with Clause

Pass additional variables to nested structures:

folders:
  - frontend/:
      struct: project/react
      with:
        app_name: "{{@ project_name @}}-frontend"
        port: 3000
  - backend/:
      struct: project/node
      with:
        app_name: "{{@ project_name @}}-backend"
        port: 8000

Variables defined in with are merged with global variables and take precedence.

Advanced Examples

Conditional File Creation

files:
  - docker-compose.yml:
      skip: "{{@ not use_docker @}}"
      content: |
        version: '3.8'
        services:
          app:
            image: {{@ project_name | slugify @}}:latest

Dynamic File Names

files:
  - "src/{{@ module_name @}}/index.js":
      content: |
        // {{@ module_name @}} module
        export default {};

Environment-Specific Content

files:
  - config/{{@ environment @}}.yml:
      content: |
        {%@ if environment == "production" @%}
        database_url: {{@ production_db_url @}}
        {%@ else @%}
        database_url: sqlite:///dev.db
        {%@ endif @%}