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
Let me start by understanding the repository structure and the issue. The issue is about
unsetAllMarksdeleting comments in a Tiptap editor. The expected behavior is thatunsetAllMarkswill remove formatting marks but not remove comment tags or comments that are configured withclearable: false.Let me explore the repository structure first, then look at the relevant files mentioned in the issue:
packages/core/src/Mark.ts- where theclearableoption needs to be addedpackages/core/src/commands/unsetAllMarks.ts- where the command needs to be modified
Let me start exploring.
Assistant
Let me look at the relevant files mentioned in the issue.
Assistant
Let me see the rest of this file and also look at the unsetAllMarks command.
Assistant
Let me see the rest of the file and also look at the unsetAllMarks command.
Assistant
Now let me look at the
unsetAllMarkscommand fileAssistant
Let me open the unsetAllMarks file.
Assistant
Now let me explore the codebase more to understand how marks are accessed and how the comment extension works
Assistant
The find command didn't output anything, probably due to the pattern. Let me try a different approach.
Assistant
Let me look at the packages directory structure
Assistant
I don't see a comment extension. Let me check deprecated packages and look for any comment-related code
Assistant
Let me look at the Extendable class and understand how marks are stored and accessed
Assistant
Let me look at how the editor stores extensions and how marks are accessed
Assistant
Let me look at the
Assistant
Let me look at the ExtensionManager to understand how marks and their configurations are stored.
Assistant
Let me look at the types to understand how commands get access to editor and other context
Assistant
Let me look at the CommandProps and RawCommands to understand how commands can access the editor.
Assistant
Now let me look at the ExtensionManager's extensions property and find how to access mark
Assistant
Now let me look at some existing commands to see patterns for accessing extension config:
Assistant
Let me look at unsetMark.ts and toggleMark.ts to see how they interact with mark configuration
Assistant
Let me look at the
getExtensionFieldhelper and how mark properties likeexitableareAssistant
Let me also look at the
callOrReturnutility and how theAssistant
Let me look at how the config is stored in the
Assistant
Let me look at the Extendable class's default config:
Assistant
Let me search for patterns where commands use
editor.extensionManagerto get extensionAssistant
Let me look for existing tests for unsetAllMarks:
Assistant
Let me check existing tests in the core package
Assistant
Let me check the package.json for test commands
Assistant
Let me check the test script more and the core package.json
Assistant
Now let me implement the solution. First, let me add the
clearableproperty to theMarkConfiginterface:Assistant
Let me open the Mark.ts file
Assistant
Let me use the goto command to navigate the file
Assistant
Now let me add the
clearableproperty to theMarkConfiginterface. I'll add it after theaddAttributesproperty:Assistant
Let me use the proper heredoc syntax:
Assistant
Let me try a different approach - using the heredoc syntax:
Assistant
Good, the
clearableproperty has been added to MarkConfig. Now let me modify theunsetAllMarkscommand:Assistant
Let me try different commands.
Assistant
Let me check how properties like
exitableare resolved in the codebase to follow the same pattern:Assistant
Let me look at how exitable is used in the ExtensionManager:
Assistant
Let me check how other boolean-function properties like
keepOnSplitare usedAssistant
Now I have a clear pattern. Let me modify the
unsetAllMarkscommand usingcallOrReturn+getExtensionFieldpatternAssistant
Now let me verify the code compiles by running the TypeScript check
Assistant
The errors are in demos, not in core. Let me filter for only core errors
Assistant
It says there's no such file or directory... but we're in /tiptap. Let me check.
Assistant
I see, the current directory is
/tiptap/packages/core. Let me check fromAssistant
Let me run the TypeScript check from the correct
Assistant
No errors for our files. Let me also run the core tests to make sure nothing breaks:
Assistant
All 377 tests pass. Now let me create a test script to verify the fix works correctly for the described behavior:
Assistant
Now let me run the test script
Assistant
Let me fix the script to use absolute paths
Assistant
Let me check how other files import these modules:
Assistant
Let me look at how existing test files import modules:
Assistant
Let me create a test using vitest within the core package
Assistant
Now let me run the test:
Assistant
All 4 tests pass. Let me also run the full test suite to make sure nothing is broken:
Assistant
All 381 tests pass. Now let me remove the test file as instructed (we should not add new tests
Assistant
Now let me verify the final state of both modified files:
Assistant
Let me see the bottom part of Mark.ts where I added the clearable property
Assistant
I notice a missing blank line before the
/**comment for Attributes. Let me fix that:Assistant
Now let me verify the unsetAllMarks.ts file:
Assistant
Let me run the full test suite one more time to confirm everything passes:
Assistant
All 377 tests pass. Let me check the git diff to verify all changes are correct:
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 →