Skip to content

v0.2.1 — doctor --explain + versioning policy

Choose a tag to compare

View all tags
@Juliocbm Juliocbm released this 24 May 03:46
v0.2.1
3f430f0

Polish patch for v0.2.0 — symmetry with lint --explain from v0.1.8, plus a documented versioning policy.

✨ New

  • beacon doctor --explain [check] — verbose docs for each of the 4 doctor checks: area, why it exists, what triggers it, an example finding, and when it's not flagged. Run with no check name to list all checks grouped by area.

    beacon doctor --explain                    # list all checks
beacon doctor --explain stale-plans        # explain a specific check
beacon doctor --explain stalplans          # typo → "Did you mean stale-plans?"

    Mirrors beacon lint --explain from v0.1.8 — same Levenshtein-based typo correction for unknown check names. Both lint and doctor now have the same self-documenting surface.

📖 Docs

  • New "Versioning policy" section in README — explicit SemVer commitment, explains why versions can jump (e.g., 0.1.8 → 0.2.0 was a new top-level command, not a polish of lint). Future patches stay in 0.2.x; the next minor (0.3.0) is reserved for the next feature surface.

🧹 Housekeeping

  • Removed docs/backlog/beacon-doctor-health-checks.todo.md from the backlog — the feature shipped in v0.2.0, so the durable record is now ADR-007 + the implementation in src/doctor/.

🧰 Internal

  • New module src/doctor/check-docs.ts parallel to src/linter/rule-docs.ts. 6 new unit tests. Test suite now at 226 passing across 38 files.

Install / upgrade

npm install -g beacon-docs@0.2.1
# or one-off:
npx beacon-docs@latest doctor --explain

Full changelog: https://github.com/Juliocbm/beacon-docs/blob/main/CHANGELOG.md

Assets 2
Loading