plan 89: address Copilot review on PR #147 - #148
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #148 +/- ##
=======================================
Coverage 86.76% 86.76%
=======================================
Files 96 96
Lines 10446 10446
=======================================
Hits 9063 9063
Misses 900 900
Partials 483 483 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
Updates plan 89’s specification for the upcoming <?toc?>...<?/toc?> directive and related MDS035 fix behavior, aligning it with current rule numbering and existing anchor/slug logic used elsewhere in mdsmith.
Changes:
- Renumbers the planned TOC rule from MDS036 → MDS037 and documents the numbering rationale.
- Specifies reusing (and extracting) existing heading-anchor slug/disambiguation logic from
crossfilereferenceintegrityinto a shared helper underinternal/mdtext/. - Removes/clarifies incorrect directive and rule-interaction details (no
<?listindent?>, MDS015 scope, canonical empty<?toc?>block form).
- Renumber MDS036 → MDS037 for the toc rule. Plan 51 shipped first and took MDS036 for max-section-length; MDS034 stays reserved for plan 86. - Replace the hand-rolled slug algorithm with a directive to move the existing slugify / duplicate-disambiguation logic out of crossfilereferenceintegrity into a shared helper (internal/mdtext) that both rules call. Drops incorrect goldmark-meta reference. - Drop fictitious <?listindent?> directive reference; describe indentation as MDS016 list-indent.spaces (default 2). - Correct MDS015 interaction note: MDS015 only covers fenced code blocks, so blank-line padding around <?toc?> is MDS035 Fix's responsibility. - Unify the canonical empty-body form as <?toc?>\n<?/toc?> throughout design, tasks, and acceptance criteria. - Add task 1 (move slug helper to shared package) and renumber downstream tasks. - Grammar pass: "GitHub-style" consistently. Follow-up to PR #147 (already merged).
7b998e9 to
fe1437e
Compare
Copilot noted that `list-indent.spaces` implies a flat key that doesn't exist in .mdsmith.yml; the actual config is nested under list-indent with a 'spaces' field. Reword to match.
Line numbers drift as the file evolves. Replace 'around lines 349 and 389' with a reference to the collectHeadingAnchors / slugify helpers.
c293646 to
6a6db67
Compare
|
🟢 Merge Queue — picked up This PR is in the queue and will be batched with other Next: No action needed — you'll get another comment when CI starts on the batch. View merge queue run. |
|
🔵 Merge Queue — CI running Merged into batch branch Next: No action needed — you'll be notified when CI completes. |
|
✅ Merge Queue — merged This PR landed on Next: Done — nothing more to do here. |
Summary
Follow-up to PR #147 (already merged). Addresses six Copilot review threads on the plan 89 document that were not resolved before merge.
Changes
MDS036→MDS037for the toc rule. Plan 51 (PR plan 51: add MDS036 section-size-limits rule #143) merged first and tookMDS036formax-section-length.MDS034remains reserved for plan 86.slugifyand the duplicate-anchor counter out ofinternal/rules/crossfilereferenceintegrity/into a shared helper (internal/mdtext/) that both rules call. Drops the incorrectgoldmark-metareference.<?listindent?>— it is not a real directive. Describe list indentation in terms of MDS016list-indent.spaces(default 2).<?toc?>is MDS035 Fix's responsibility.<?toc?>\n<?/toc?>everywhere (design, tasks, acceptance criteria).Test plan
mdsmith check .passes