You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Treat example configs as executable documentation and prevent broken examples from landing.
Suggested Approach
Add an automated test that discovers committed TOML files under examples/ and loads each with HudConfig::load_from_path or equivalent real parser path.
A unit test is probably enough. If path handling is awkward from a unit test, use an integration test under tests/.
Scope
Validate every committed examples/*.toml.
Include current examples: examples/dogfood.toml and examples/kitchen-sink.toml.
Parent: #17
Goal
Treat example configs as executable documentation and prevent broken examples from landing.
Suggested Approach
Add an automated test that discovers committed TOML files under
examples/and loads each withHudConfig::load_from_pathor equivalent real parser path.A unit test is probably enough. If path handling is awkward from a unit test, use an integration test under
tests/.Scope
examples/*.toml.examples/dogfood.tomlandexamples/kitchen-sink.toml.examples/starter.tomlonce added under examples: add public starter config and polish showcase configs #24.Files Likely Touched
src/config.rs, ortests/examples.rs, orsrc/lib.rsif exposing parser helpers is needed.Non-Goals
gh,tmux, ortaskare installed.Verification
Run:
Optional manual sanity check:
Acceptance Criteria
./scripts/check.examples/*.tomlfiles are covered automatically.