Skip to content

docs(markdown-parser): add code-version comments to ungram nodes#9444

Merged
ematipico merged 1 commit intobiomejs:mainfrom
jfmcdowell:fix/ungram-code-comments
Mar 11, 2026
Merged

docs(markdown-parser): add code-version comments to ungram nodes#9444
ematipico merged 1 commit intobiomejs:mainfrom
jfmcdowell:fix/ungram-code-comments

Conversation

@jfmcdowell
Copy link
Copy Markdown
Contributor

Note

AI Assistance Disclosure: This PR was developed with assistance from Claude Code.

Summary

Add code-version comments (showing the markdown syntax with caret underlines) to ungram nodes that were missing them, per reviewer feedback on #9427.

  • Add code examples to MdHtmlBlock, MdLinkReferenceDefinition, MdLinkLabel, MdLinkDestination, MdLinkTitle, MdQuote, MdQuotePrefix, MdListMarkerPrefix, MdReferenceLinkLabel, MdInlineHtml, MdEntityReference.
  • Fragment nodes (MdQuotePrefix, MdListMarkerPrefix) use fragment-shaped examples to avoid confusion with their parent nodes.

Test Plan

  • just test-crate biome_markdown_parser
  • just test-markdown-conformance (652/652, 100%)
  • just f && just l

Docs

N/A — comment-only change to the ungram grammar file.

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Mar 11, 2026

⚠️ No Changeset found

Latest commit: eff2604

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Add code-version comments (showing the markdown syntax) to nodes
that were missing them in the ungram grammar file.
@jfmcdowell jfmcdowell force-pushed the fix/ungram-code-comments branch from f62b632 to eff2604 Compare March 11, 2026 10:40
@jfmcdowell jfmcdowell marked this pull request as ready for review March 11, 2026 11:02
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 11, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 4a340d61-efb8-4fdf-a608-1dfde9af4b8d

📥 Commits

Reviewing files that changed from the base of the PR and between f2debed and eff2604.

📒 Files selected for processing (1)
  • xtask/codegen/markdown.ungram

Walkthrough

This change updates the Markdown grammar file to introduce new public CST node types for link components (MdLinkLabel, MdLinkDestination, MdLinkTitle), inline HTML, entity references, and detailed prefix structures for quotes and lists. MdLinkReferenceDefinition is restructured to use these new explicit label, destination, and title components. Quote and list prefixes gain structured representations with indentation and marker information. Documentation comments are added to annotate the new and existing public nodes.

Possibly related PRs

Suggested reviewers

  • ematipico
🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: adding code-version comments to ungram nodes for documentation purposes.
Description check ✅ Passed The description is well-related to the changeset, explaining the purpose of adding code-version comments to specific ungram nodes and providing test coverage details.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@ematipico ematipico merged commit 1e63555 into biomejs:main Mar 11, 2026
12 checks passed
@jfmcdowell jfmcdowell deleted the fix/ungram-code-comments branch March 11, 2026 13:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-Tooling Area: internal tools

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants