fix(markdown): collapse soft line breaks into spaces - #8139
Open
lazerg wants to merge 1 commit into
Open
Conversation
✅ Deploy Preview for tiptap-embed ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
🦋 Changeset detectedLatest commit: 0a88753 The changes in this PR will be included in the next version bump. This PR includes changesets to release 74 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Contributor
📝 WalkthroughSummary
WalkthroughMarkdown parsing now collapses CommonMark soft line breaks into spaces while preserving newlines in fenced code blocks. Tests cover plain paragraphs, links, inline marks, and conversion fixtures. ChangesSoft line break parsing
Estimated code review effort: 3 (Moderate) | ~20 minutes Suggested labels: Suggested reviewers: Sequence Diagram(s)sequenceDiagram
participant MarkdownInput
participant MarkdownManager
participant ProseMirrorDocument
MarkdownInput->>MarkdownManager: Parse markdown
MarkdownManager->>MarkdownManager: Collapse soft line breaks in text tokens
MarkdownManager->>ProseMirrorDocument: Build text nodes with spaces
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
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. Comment |
coderabbitai
Bot
added
area: markdown
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (1)
packages/markdown/__tests__/soft-line-break.spec.ts (1)
1-15: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winAdd regression tests for code spans and hard breaks.
The suite covers fenced code blocks, but not the other preservation guarantees in this PR. Register the relevant extensions in the test manager and add cases proving that code-span newlines remain unchanged and explicit hard breaks remain
hardBreaknodes.As per coding guidelines, deterministic user-visible behavior should have unit-test coverage, and the PR objective explicitly includes preserving code-span newlines and explicit hard breaks.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@packages/markdown/__tests__/soft-line-break.spec.ts` around lines 1 - 15, Extend the “Soft line breaks” tests around the MarkdownManager setup to register the relevant hard-break extension, then add regression cases for inline code spans and explicit hard breaks. Verify code-span newlines are preserved unchanged and hard-break syntax parses into hardBreak nodes, while keeping the existing fenced-code coverage intact.Source: Coding guidelines
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@packages/markdown/__tests__/soft-line-break.spec.ts`:
- Around line 1-15: Extend the “Soft line breaks” tests around the
MarkdownManager setup to register the relevant hard-break extension, then add
regression cases for inline code spans and explicit hard breaks. Verify
code-span newlines are preserved unchanged and hard-break syntax parses into
hardBreak nodes, while keeping the existing fenced-code coverage intact.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Organization UI (inherited)
Review profile: CHILL
Plan: Pro Plus
Run ID: 088595a0-5c61-47c8-b14d-393c26a071e2
📒 Files selected for processing (5)
.changeset/2026-07-29-collapse-soft-line-breaks.mdpackages/markdown/__tests__/conversion-files/soft-break-marks.tspackages/markdown/__tests__/soft-line-break.spec.tspackages/markdown/src/MarkdownManager.tspackages/markdown/src/utils.ts
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
1 participant
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.
Fixes
Fixes #8136
Changes and Review
marked keeps a soft-wrapped paragraph's newlines inside its
texttokens, leaning on the CommonMark rule that a soft break may render as either a space or a line ending in HTML, where whitespace collapses.MarkdownManagerlowers that text straight into a ProseMirror node, which has no whitespace collapsing, so underwhite-space: break-spacesa wrapped paragraph renders across several lines instead of one. This collapses each soft break and its flanking spaces to a single space in the two branches that turn atexttoken into a text node; code blocks and code spans don't route through those branches so they keep their newlines, and explicit hard breaks stayhardBreak. One existing round-trip fixture is updated to the collapsed form, reflecting the trade-off that a markdown to doc to markdown round trip loses the author's original wrap columns.To verify, parse
foo\nbarand check it yields a single paragraphfoo bar, or runpnpm vitest run packages/markdown.Checklist
Responsibility