ISSUE DESCRIPTION [PRO]: unsetAllMarks deletes comments Affected Packages…
- User
ISSUE DESCRIPTION
[PRO]: unsetAllMarks deletes comments
Affected Packages
extension-comments
Version(s)
2.17.5
Description of the Bug
Our Tiptap editor has a "clear formatting" button that calls
unsetAllMarksto remove formatting from the selection.We noticed, however, that if the selection includes content associated with a comment, the comment is also deleted (presumably because the
<span>element wrapping the content is removed).Is this a bug? I can see how we might want
unsetAllMarksto include comments, if we consider the comment tag a "mark," but at the same time I imagine users would generally not expectunsetAllMarksto delete comments.For now, as a workaround, we are calling
unsetMarkseparately for all non-comment marks, e.g.editor.chain().focus().unsetMark('link').unsetMark('bold').unsetMark('strike') ...... but would be nice to be able to use
unsetAllMarksagain for formatting-specific marks. Thanks!Browser Used
Chrome
Code Example (Preferred)
No response
Expected Behavior
unsetAllMarkswill remove formatting marks (listed here) but not remove comment tags or comments.Additional Context (Optional)
No response
Dependency Updates
- Yes, I've updated all my dependencies.
Evaluation contract
Marks are clearable by default. A mark configured with
clearable: falsemust surviveunsetAllMarks(), whileunsetAllMarks({ignoreClearable: true})removes it. Callingcan().unsetAllMarks()on a selection containing only non-clearable marks is a successful no-op and must returntrue; explicitly callingunsetMarkmay still remove a non-clearable mark.Interface
Type: Mark configuration option Name: MarkConfig.clearable Path: packages/core/src/Mark.ts Type: boolean | (() => boolean) Default: true Description: Controls whether unsetAllMarks removes this mark. Set false for semantic marks such as comments that must survive clear-formatting operations.
Type: Command Name: unsetAllMarks Path: packages/core/src/commands/unsetAllMarks.ts Input: options?: { ignoreClearable?: boolean } Output: ReturnType Description: Removes clearable marks from the current selection. Marks configured with clearable: false are preserved unless ignoreClearable is true. can().unsetAllMarks() returns true when the selection contains only non-clearable marks; this case is a successful no-op.
ADDITIONAL ADVICE
Since you are given a git repository, you can use git commands to simplify your work. For example, if you made a mistake and want to revert your changes, you can use
git checkout <file>to restore the file to its original state. You can also reset all changes in the repository usinggit reset --hardcommand. Additionally, you can usegit stashandgit stash popto temporarily save your changes and restore them later. Finally, you can see the changes that you've made (which will be submitted when you callsubmit) usinggit statusorgit diffcommands. However you don't need to usegit addorgit commitbefore submitting your changes. In fact,submitonly submits currently unstaged changes because it usesgit diffto get the changes that need to be submitted.CHECKLIST
Before submitting your solution, please go over the following checklist and make sure you've done everything:
- If an error was reported in the issue description, I have successfully reproduced it.
- If an error was reported in the issue description, I have confirmed that my fix resolves the error.
- I have thought about edge cases and made sure my fix handles them as well.
- I have run existing tests in the repository that might have been affected by the change I made and confirmed that they pass. I want you to list every bullet from this checklist and write your reasoning for why you think you did it or didn't need to.
Repository has been uploaded and your shell is currently at the repository root. Time to solve the issue!
(Current directory: /tiptap, current file: none) bash-$
- Assistant
I'll explore the repository structure and the relevant mark/unsetAllMarks code to implement the
clearableoption. - Assistant
Let me look at the Mark.ts, unsetAllMarks.ts, and comments extension.
- Assistant
Let me continue reading Mark.ts and find comments extension, types, etc.
- Assistant
Checking how other mark options like
keepOnSplitare resolved, and looking for related tests or docs. - Assistant
I'll inspect how commands access the editor/extensions and how similar mark options are evaluated.
- Assistant
Looking at how marks are filtered elsewhere and for comment extensions or recent related changes.
- Assistant
Inspecting ExtensionManager and similar patterns for filtering marks.
- Assistant
Searching for the comments extension and reviewing how related packages are structured.
- Assistant
Implementing the
clearableconfig and updatingunsetAllMarks. Checking exports and nearby mark-option docs/style. - Assistant
Let me implement the changes. I'll also check how getExtensionField works with boolean fields - for keepOnSplit, they use: I understand the issue you're describing with
unsetAllMarksand comments. The current behavior is indeed a bug, and your proposed workaround makes sense.Let me think through the implementation:
- We need to modify
unsetAllMarksto respect theclearableoption on marks - Comments should have
clearable: falseby default (as per the evaluation contract) - The
ignoreClearableoption should still allow clearing non-clearable marks when explicitly requested
Here's the updated implementation:
import { getExtensionField } from '../helpers/getExtensionField. - We need to modify
- Assistant
Implementing
clearableon Mark and updatingunsetAllMarks. - Assistant
Fixing spacing and updating
unsetAllMarks. - Assistant
I accidentally broke the Inclusive comment — fixing that now.
- Assistant
Restoring Mark.ts from git and reapplying the change carefully.
- Assistant
I'll use replace for better precision.
- Assistant
Fixing the incomplete import in
unsetAllMarks.ts. - Assistant
Checking test patterns and writing a verification script.
- Assistant
Checking how packages resolve for local testing, and building a temporary verification script.
- Assistant
Creating a temporary verification script outside the packages tree.
- Assistant
Trying another way to run the verification script:
- Assistant
Investigating the Node/glibc environment issue.
- Assistant
Unsetting the bad
LD_LIBRARY_PATHand re-running the test. - Assistant
Running the script via
tsx/vite-nodeinstead of Vitest. - Assistant
Placing a temporary Vitest file under packages and running it.
- Assistant
All behavioral checks passed. Cleaning up the temp test and verifying formatting.
- Assistant
Running unit tests and a quick lint check on the changed files.
Other models, same or similar prompt
Responses were produced in different, uncontrolled contexts (system prompts, settings, prior turns). This is not a benchmark.
Identical first prompt
claude-sonnet-5Compare side by side →
claude-sonnet-5Compare side by side →
claude-sonnet-5Compare side by side →
claude-sonnet-5Compare side by side →
claude-sonnet-5Compare side by side →
Qwen/Qwen3.6-35B-A3BCompare side by side →
Qwen/Qwen3.6-35B-A3BCompare side by side →
Qwen/Qwen3.6-35B-A3BCompare side by side →
Qwen/Qwen3.6-35B-A3BCompare side by side →
Qwen/Qwen3.6-27BCompare side by side →
Qwen/Qwen3.6-27BCompare side by side →
Qwen/Qwen3.6-27BCompare side by side →