fix: improve template variable error messages #58

Merged

Charon merged 1 commit from fix/template-variable-error-messages into main

2026-02-24 13:21:14 +00:00

Clotho commented

2026-02-23 11:49:31 +00:00

Member

Summary

Enhances validateVariables() in PlanTemplateService to produce actionable errors that include the variable's description, expected format, and example values
Adds naming_convention field to validation result so callers know variable names use snake_case
Adds 6 new test cases covering all enhanced error message fields

Test plan

All existing PlanTemplateServiceTest validation tests pass
New tests verify description, example, examples list, format, naming_convention, and bare-variable cases

Closes #30

🤖 Generated with Claude Code

## Summary - Enhances `validateVariables()` in `PlanTemplateService` to produce actionable errors that include the variable's description, expected format, and example values - Adds `naming_convention` field to validation result so callers know variable names use snake_case - Adds 6 new test cases covering all enhanced error message fields ## Test plan - [ ] All existing `PlanTemplateServiceTest` validation tests pass - [ ] New tests verify description, example, examples list, format, naming_convention, and bare-variable cases Closes #30 🤖 Generated with [Claude Code](https://claude.ai/claude-code)

Clotho added 1 commit 2026-02-23 11:49:31 +00:00

fix: improve template variable error messages (#30 )

CI / PHP 8.3 (pull_request) Failing after 1m37s

Details

CI / PHP 8.4 (pull_request) Failing after 1m36s

Details

91ee71b8a1

Enhance `validateVariables()` in `PlanTemplateService` to produce
actionable errors instead of the generic "Required variable '...' is missing".

Changes:
- Extracted `buildVariableError()` helper that composes the message from
  the variable's `description`, `format`, `example`, and `examples` fields
- Added `naming_convention` key to the returned array so callers have
  a constant reminder that variable names use snake_case
- Added a `NAMING_CONVENTION` private const to avoid string duplication

Tests (6 new cases in `PlanTemplateServiceTest`):
- description included in error message
- single `example` value included
- `examples` list (first two) included
- `format` hint included alongside example
- `naming_convention` present in both valid and invalid results
- bare variable (no description) still produces useful "missing" message

Closes #30

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>