Skip to content

docs: close visibility features (#261, #262, #264, #265)#273

Draft
ColumbusLabs wants to merge 1 commit into
mainfrom
cursor/visibility-closeout-261-265-01fd
Draft

docs: close visibility features (#261, #262, #264, #265)#273
ColumbusLabs wants to merge 1 commit into
mainfrom
cursor/visibility-closeout-261-265-01fd

Conversation

@ColumbusLabs

Copy link
Copy Markdown
Owner

Summary

Closes four already-shipped open issues whose merge PRs referenced them but left them open. This PR documents and hardens the visibility / design-smell cluster:

  1. god-file — kitchen-sink module detector (#261)
  2. cognitive-complexity — Sonar-style nesting score (#262)
  3. HTML import-graph + debt treemap (#264)
  4. --format badge SVG + shields.io endpoint (#265)

Why this cluster

These four features landed on main in waves 1–3 but the GitHub issues stayed open. They share one job: make structure and severity of debt visible (module sprawl, readability, architecture graph, README badge). Adoption workflow issues #251/#252/#255/#256 are already covered by #272.

Scope

  • This change is focused on one issue or one small improvement.
  • I updated docs or examples if behavior changed.
  • I added or updated tests for code changes.
  • If I added or changed a rule, I noted its pack in docs/rule-packs.md when applicable.

Changes

Docs

  • docs/rule-packs.md: long-parameter-list, god-file, cognitive-complexity
  • docs/rules.md: cognitive complexity scoring model vs complex-control-flow
  • docs/report-gallery.md: HTML graph/treemap + badge format
  • README: prefer debtlens scan --format badge over manual jq
  • CHANGELOG issue links for #261#265

DX / tests

  • Shell completions include badge
  • HTML reporter tests cover import-graph cycle edges + self-contained output
  • Graph reporter test covers cycle highlighting
  • Docs contract test for report-gallery badge/graph surfaces

Deferred (follow-up PRs)

Issues Why deferred
#258, #259 Shipped in 0.4.0 / PR #267; trivial closeout, separate from this theme
#263, #266 RFC-scoped deliveries; need explicit “shipped MVP” acknowledgment
#251#256 Already in open PR #272

Validation

npm run test:all
npm run build

Closes #261, #262, #264, #265

Open in Web Open in Cursor 

…, badge

Document and harden the already-shipped reporting and design-smell surface:
god-file / cognitive-complexity in rule packs, HTML import-graph + treemap,
and --format badge. Shell completions now include badge; reporter tests cover
cycle highlighting and self-contained HTML output.

Closes #261, #262, #264, #265

Co-authored-by: ColumbusLabs <ColumbusLabs@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add composite god-file / kitchen-sink module detector

2 participants