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 files for marks and
unsetAllMarks. - Assistant
Next I'll inspect
unsetAllMarks,Mark.ts, and the comments package. - Assistant
I'll locate the comments extension and see how marks are registered in the schema.
- Assistant
There's no extension-comments in the open source repo, maybe it's in a private package. Looking at the issue evaluation contract:
- Assistant
I'll check how commands receive the editor and how other commands filter marks.
- Assistant
Let me look at how extensions store config and how we accessible extension by mark name. Also check if there's any existing PR/diff or changelog mentioning this.
- Assistant
I'll also check
callOrReturnand look for any comments-related mark code. - Assistant
Checking how to run unit tests and any existing patterns for command tests.
- Assistant
I'll look at existing command/mark tests and
index.tsexports. - Assistant
I'll inspect ExtensionManager for how mark extensions are exposed.
- Assistant
Checking recent history and whether dist artifacts need updating.
- Assistant
There's prior "clearable" work on text style — I'll check that commit and related APIs.
- Assistant
Checking mark setup and how
exitableis stored for similar optional fields. - Assistant
Implementing
clearableon Mark and updatingunsetAllMarks. - Assistant
I'll add clearable after keepOnSplit or after exitable.
- Assistant
I'll insert a blank line for consistency and update
unsetAllMarks. - Assistant
I need to restore the Inclusive comment that was removed.
- Assistant
Fixing the Inclusive JSDoc and writing
unsetAllMarks.tscorrectly. - Assistant
Confirming the extension has a
storagefield and cleaning up the implementation. - Assistant
I'll refine the implementation and run a quick verification test.
- Assistant
Fixing the typo in the options assignment.
- Assistant
I'll write a temporary script to verify the behavior end-to-end.
- Assistant
I'll run the test via vitest from the packages directory.
- Assistant
Retrying the unit test with a longer wait for vitest.
- Assistant
Verification passed. Cleaning up the temp test and running related unit tests.
- Assistant
I'll run the linter and formatter on the changed files.
- Assistant
Confirming
extension.storageexists and is initialized. - Assistant
I'll use
editor.extensionStoragefor consistency with the rest of the codebase. - Assistant
Running a final quick verification, then submitting.
- Assistant
Removing the temporary test and submitting the fix.
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 →