Use CommonMark parsing for section-header-quality headings - #156
Merged
Merged
Conversation
Replace raw Markdown heading scanning with the shared parser while preserving HTML/MDX callout exclusions and existing check results. Add regression coverage for rendered heading labels, code/comments, mixed panels, line endings, and request invariants. Fixes #153
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
The score-changing behavior requires the repository-mandated scoring-version update.
Review effort: Balanced
Findings: 1
Open (1)
What changed in this PR
Uses CommonMark parsing to improve section-header-quality accuracy while preserving HTML/MDX behavior.
Changes:
- Supports rendered Markdown and setext headings.
- Excludes headings in code, comments, and callouts.
- Adds regression coverage and documentation.
| File | Description |
|---|---|
src/checks/content-structure/section-header-quality.ts |
Implements parser-backed heading extraction. |
test/unit/checks/section-header-quality.test.ts |
Adds heading and MDX regressions. |
docs/checks/content-structure.md |
Documents measured headings and exclusions. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #153.
Tab/TabItemwrapper compatibility without requiring blank-line separators. Leave classification thresholds, public result fields, dependencies, and request behavior unchanged.Validation
npm run lintnpm run format:checknpm run version:checknpm run buildThe implementation and tests match the fully validated snapshot. A subsequent documentation-only edit also passed its focused formatting check.