registrystack / registrystack/registry-stack
bregctl diagnostic codes are undocumented and two are catch-alls
- Dominant language
- Rust
- Stars
- 2
- Forks
- 0
- Avg merge
- 2h 55m
- Merged PRs (30d)
- 130
Description
Found in the 0.28.0 pre-release review (2026-09-08). Line references are as of main after #926.
bregctl emits 97 distinct diagnostic codes; 96 have no documentation, and `dev.failed` and `examples.failed` (`crates/registry-bregctl/src/lib.rs:1592-1622`) are catch-alls that hide the specific cause. `SuggestedAction` has 47 variants (`lib.rs:1076-1123`).
Proposed: generate a diagnostic reference from the enum (same approach as the CLI reference), and replace the two catch-alls with specific codes so a reader can search the code they see.
Contributor guide
Research direction
Start in crates/registry-bregctl/src/lib.rs, reading SuggestedAction at lines 1076-1123 and the dev.failed/examples.failed handling at lines 1592-1622. Compare the existing CLI reference generation approach, then trace the diagnostic enum and its 97 emitted codes. Done means the codes have a generated reference and the two catch-alls are replaced with specific searchable codes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- cli, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100