fix: Inline code clears comments (BLO-1207) by matthewlipski · Pull Request #2832 · TypeCellOS/BlockNote

matthewlipski · 2026-06-04T09:23:26Z

Summary

This PR fixes an issues where comments cannot overlap inline code. This is because the inline code mark has exclude: "_" in its spec, meaning no other marks can overlap it. This makes sense for things like colors and bold/italic/etc, but not comments. Therefore, an exception has been added.

Closes #2803

Rationale

This is a bug.

Changes

Extended Code mark with onBeforeCreate to remove the comment mark from the exclude array.

Impact

N/A

Testing

Added e2e test.

Screenshots/Video

N/A

Checklist

Code follows the project's coding standards.
Unit tests covering the new feature have been added.
All existing tests pass.
The documentation has been updated to reflect the new feature

Additional Notes

N/A

Summary by CodeRabbit

Bug Fixes
- Resolved an issue preventing inline code formatting from being applied to previously-commented text. Comment formatting is now preserved alongside code formatting, allowing both styles to coexist on the same text selection.

vercel · 2026-06-04T09:23:33Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
blocknote	Error		Jun 4, 2026 10:04am
blocknote-website	Error		Jun 4, 2026 10:04am

coderabbitai · 2026-06-04T09:23:42Z

📝 Walkthrough

Walkthrough

Code marks now allow comment marks to overlap by removing the comment mark from the exclusion list when the mark is created. A lifecycle hook filters the exclusion list conditionally, and an end-to-end test validates that comments and inline code coexist on the same text selection.

Changes

Code and Comment Mark Overlap

Layer / File(s)	Summary
Mark exclusion lifecycle and type setup `packages/core/src/blocks/defaultBlocks.ts`	`MarkType` is imported for type safety in the code mark's `onBeforeCreate` hook, which filters the `comment` mark from the code mark's `excluded` list, allowing the marks to coexist.
End-to-end test for mark overlap `tests/src/end-to-end/comments/comments.test.tsx`	Test context is updated to import `MOD` constant, and a new test case verifies that inline code formatting is applied and the comment thread remains visible when code is toggled on previously-commented text.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested reviewers

nperez0111

Poem

A comment in the dark, a code mark so bright,
Now dancing together, a mark-overlap sight! 🐰✨
No more do they fight o'er the selfsame text,
Both styling in peace—what a markup context!

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (2 warnings)

Check name	Status	Explanation	Resolution
Linked Issues check	⚠️ Warning	The linked issue `#2803` concerns table indentation behavior, which is completely unrelated to the PR changes addressing comments overlapping inline code.	Verify the correct issue is linked. The PR fixes issue `#2803` per the description, but that issue describes table un-nesting problems, not comment-code overlap issues.
Title check	⚠️ Warning	The title describes fixing inline code clearing comments, but the PR objectives show it actually fixes comments overlapping inline code—the opposite problem. The title is misleading about the core fix.	Update the title to accurately reflect the fix: e.g., 'fix: Allow comments to overlap inline code (BLO-1207)' to match the actual implementation.

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description check	✅ Passed	The description covers Summary, Rationale, Changes, Impact, Testing, and Checklist sections, though Unit tests and documentation updates are unchecked and marked as not done.
Out of Scope Changes check	✅ Passed	Changes are scoped to allowing comments to overlap inline code via onBeforeCreate hook and a corresponding e2e test, which directly addresses the stated objective.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches

📝 Generate docstrings

Create stacked PR
Commit on current branch

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch comments-inline-code

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.}

pkg-pr-new · 2026-06-04T09:27:24Z

Open in StackBlitz

@blocknote/ariakit

npm i https://pkg.pr.new/@blocknote/ariakit@2832

@blocknote/code-block

npm i https://pkg.pr.new/@blocknote/code-block@2832

@blocknote/core

npm i https://pkg.pr.new/@blocknote/core@2832

@blocknote/mantine

npm i https://pkg.pr.new/@blocknote/mantine@2832

@blocknote/react

npm i https://pkg.pr.new/@blocknote/react@2832

@blocknote/server-util

npm i https://pkg.pr.new/@blocknote/server-util@2832

@blocknote/shadcn

npm i https://pkg.pr.new/@blocknote/shadcn@2832

@blocknote/xl-ai

npm i https://pkg.pr.new/@blocknote/xl-ai@2832

@blocknote/xl-docx-exporter

npm i https://pkg.pr.new/@blocknote/xl-docx-exporter@2832

@blocknote/xl-email-exporter

npm i https://pkg.pr.new/@blocknote/xl-email-exporter@2832

@blocknote/xl-multi-column

npm i https://pkg.pr.new/@blocknote/xl-multi-column@2832

@blocknote/xl-odt-exporter

npm i https://pkg.pr.new/@blocknote/xl-odt-exporter@2832

@blocknote/xl-pdf-exporter

npm i https://pkg.pr.new/@blocknote/xl-pdf-exporter@2832

commit: 21c0866

github-actions · 2026-06-04T09:28:12Z

PR Preview Action v1.8.1
🚀 View preview at https://TypeCellOS.github.io/BlockNote/pr-preview/pr-2832/
Built to branch `gh-pages` at 2026-06-04 15:50 UTC. Preview will be ready when the GitHub Pages deployment is complete.

nperez0111 · 2026-06-17T14:06:35Z

+      onBeforeCreate() {
+        // By default, code marks are configured to not overlap with any other
+        // marks with `exclude: "_"`. However, comment marks should still be
+        // allowed to overlap code marks. There is unfortunately no way to make
+        // the `exclude` option contain all possible marks except comments, so
+        // we instead remove the comment mark from it in `onBeforeCreate`.
+        const commentType = this.editor.schema.marks.comment;
+        const codeType = this.type as MarkType & {
+          excluded?: readonly MarkType[];
+        };
+
+        if (commentType && codeType.excluded?.includes(commentType)) {
+          codeType.excluded = codeType.excluded.filter(
+            (markType) => markType !== commentType,
+          );
+        }
+      },


I don't love this solution, can the excluded be a function in tiptap? And we can read the editor to see the other marks that exist in the schema. It being a runtime hack isn't great, especially when we can know all of the marks that the editor has included in it

matthewlipski added 2 commits June 3, 2026 16:28

Fixed comment marks not getting applied to inline code

a764fe9

Merge branch 'main' into comments-inline-code

21c0866

matthewlipski requested a review from nperez0111 June 4, 2026 09:23

vercel Bot had a problem deploying to Preview – blocknote-website June 4, 2026 10:04 Failure

matthewlipski changed the title ~~fix: Inline code clears comments (BLO-1211)~~ fix: Inline code clears comments (BLO-1207) Jun 4, 2026

nperez0111 reviewed Jun 17, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix: Inline code clears comments (BLO-1207)#2832

fix: Inline code clears comments (BLO-1207)#2832
matthewlipski wants to merge 2 commits into
mainfrom
comments-inline-code

matthewlipski commented Jun 4, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

vercel Bot commented Jun 4, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Jun 4, 2026 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Suggested reviewers

Poem

❌ Failed checks (2 warnings)

Uh oh!

pkg-pr-new Bot commented Jun 4, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Jun 4, 2026 •

edited

Loading

Built to branch `gh-pages` at 2026-06-04 15:50 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

Uh oh!

nperez0111 Jun 17, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

matthewlipski commented Jun 4, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Rationale

Changes

Impact

Testing

Screenshots/Video

Checklist

Additional Notes

Summary by CodeRabbit

Uh oh!

vercel Bot commented Jun 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot commented Jun 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Suggested reviewers

Poem

❌ Failed checks (2 warnings)

Uh oh!

pkg-pr-new Bot commented Jun 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Jun 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Built to branch gh-pages at 2026-06-04 15:50 UTC. Preview will be ready when the GitHub Pages deployment is complete.

Uh oh!

nperez0111 Jun 17, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

matthewlipski commented Jun 4, 2026 •

edited by coderabbitai Bot

Loading

vercel Bot commented Jun 4, 2026 •

edited

Loading

coderabbitai Bot commented Jun 4, 2026 •

edited

Loading

pkg-pr-new Bot commented Jun 4, 2026 •

edited

Loading

github-actions Bot commented Jun 4, 2026 •

edited

Loading

Built to branch `gh-pages` at 2026-06-04 15:50 UTC.
Preview will be ready when the GitHub Pages deployment is complete.