CowDogMoo / warpgate / 21620188239

35%

push

github

refactor: improve documentation, config logic, and error handling across CLI and templates (#1683)

**Key Changes:**

- Standardized and clarified documentation comments across multiple packages for improved Go doc output
- Enhanced CLI environment variable and config override logic to ensure correct flag precedence
- Added comprehensive tests for root command flag and environment variable handling
- Improved signal handling and context propagation in CLI entrypoint

**Added:**

- Test suite for root command, environment variable overrides, and error conditions in `cmd/warpgate/root_test.go`
- `ApplyViperOverrides` function to ensure environment/config values populate Cobra flags unless set explicitly

**Changed:**

- Rewrote documentation comments for constructors and exported methods to follow Go doc conventions and reference types using brackets (e.g., `[Type]`)
- Improved comments for CLI and template system functions to clarify their behavior and output
- Updated `root.go` to bind and override CLI flags with environment variables/config values using a new helper, ensuring expected precedence
- Changed the signal handling in `main.go` to use `signal.NotifyContext` and propagate context cancellation to commands
- Updated `version.go` to use `cmd.Printf` for output, improving testability and consistency
- Improved documentation of manifest-related commands and options in `manifests.go`
- Updated `go.mod` to require Go 1.25.6

**Removed:**

- Outdated and redundant inline comments describing legacy implementation details, especially around configuration loading and manifest existence checks

25 of 36 new or added lines in 4 files covered. (69.44%)

3945 of 11240 relevant lines covered (35.1%)

8.02 hits per line