Add getter mode for runtime environment variable overrides#3
Merged
Conversation
📊 Code Coverage ReportCoverage by file |
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a new "getter mode" that generates runtime-configurable code as an alternative to the existing "static mode" where values are baked at build time. The getter mode generates empty structs with getter methods that check environment variables at runtime before returning TOML defaults, making it ideal for containerized deployments and open-source projects.
Key Changes
- Added
--modeCLI flag supporting "static" (default) and "getter" modes - Implemented getter method generation with runtime environment variable checking and type-safe parsing
- Generated comprehensive documentation and examples for both modes
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| readme.md | Documents getter mode usage, examples, and comparison with static mode |
| internal/generator/struct_gen.go | Implements getter method generation with env var overrides and type conversions |
| internal/generator/generator_test.go | Adds comprehensive tests for getter mode functionality |
| internal/generator/generator.go | Adds mode support and getter-specific import generation |
| example/getter_config/config.go | Example generated code demonstrating getter mode output |
| example/gen.go | Adds getter mode to go:generate directives |
| cmd/cfgx/main.go | Adds --mode flag validation and passes mode to generator |
| cfgx.go | Updates GenerateOptions and function signatures to support mode |
| Makefile | Adds generate-example target |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+612
to
+613
| section = strings.TrimSuffix(section, "Config") | ||
| section = strings.TrimSuffix(section, "Item") |
There was a problem hiding this comment.
Lines 611-612 are redundant since stripSuffix() already removes 'Config' and 'Item' suffixes. These duplicate trimming operations should be removed.
Suggested change
| section = strings.TrimSuffix(section, "Config") | |
| section = strings.TrimSuffix(section, "Item") |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add getter mode for runtime environment variable overrides
This PR introduces a new "getter mode" generation option that provides runtime environment variable overrides as an alternative to the existing "static mode" where values are baked at build time.
Changes
--modeflag to CLI (staticorgetter)Modefield toGenerateOptionsUsage
In getter mode, the generated code returns runtime environment variable values when present, falling back to TOML defaults otherwise.