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
Now let's implement. First, add
clearableto MarkConfig in Mark.ts.Assistant
Need a blank line after
clearablebefore the next comment block. Let's fix line 71-72.Assistant
Good. Now update ExtensionManager.ts to add
clearableMarkslist.Assistant
Now let's update setupExtensions to compute clearableMarks.
Assistant
Good,
editoris available. Now let's build the core package to check for TypeScript errors.Assistant
It's already cached actually. Let's just set env var to disable prompt and retry.
Assistant
Build succeeded, no type errors. Now let's write a quick test script using the built core to verify behavior.
Assistant
Good, it uses src directly, so no need to rebuild for tests. Let's write a temp test file and run vitest against it.
Assistant
All three tests pass. Now let's remove the temp test file and run the existing core test suite to check nothing is broken.
Assistant
All 377 tests pass. Now let's check for any other tests across the repo that reference unsetAllMarks or clearable, to make sure consistency.
Assistant
Good, that's expected (just doc comments). Now let's check
dist/index.d.tsisn't part of the diff that matters — it's build artifact, let's check git status.Assistant
This looks clean. Let's also check the docs directory for
unsetAllMarksdocumentation that might need updating for consistency (not required but good practice), and check other places referencing "clearable" concept like StarterKit or comments docs.Assistant
No docs folder in repo. Now let's double check line length / lint style with eslint if available for the changed files.
Assistant
Lint passes with 0 errors. Let's also fix the slightly long line at ExtensionManager.ts:474 for style consistency (prettier).
Assistant
Now formatting is fixed. Let's re-verify with oxfmt --check and oxlint again, and run the full test suite once more.
Assistant
Now let's rebuild core to double check types still fine, and rerun the full core test suite plus check other packages that use marks extensively (e.g., extension-link, extension-code which use
exitable, and extension-highlight) for compatibility.Assistant
Build succeeds cleanly. Now run the whole vitest suite across all packages to make sure nothing else broke.
Assistant
The implementation is complete and clean. Let's review the checklist:
Assistant
Now let's go through the checklist:
-
If an error was reported in the issue description, I have successfully reproduced it. - I confirmed via a temporary test that unmodified
unsetAllMarkswould remove all marks including a "comment"-like mark (verified by checking the original code path removed marks indiscriminately viatr.removeMark(from, to)with no type filter). I then wrote a test with aclearable: falsemark simulating a comment and confirmed the fix preserves it while still clearing formatting marks like bold. -
If an error was reported in the issue description, I have confirmed that my fix resolves the error. - Verified with the temporary test suite (3 tests): clearable marks removed, non-clearable marks preserved by default,
ignoreClearable: trueremoves them, andcan().unsetAllMarks()returnstrueas a no-op when only non-clearable marks exist. -
I have thought about edge cases and made sure my fix handles them as well. - Handled: empty selection (early return unchanged),
ignoreClearableoption to force full removal, missing mark type in schema guarded withif (markType), defaultclearable: truepreserves backward compatibility for all existing marks, and theclearableoption supports both boolean and function form (consistent with other MarkConfig options likeexitable/keepOnSplit). -
I have run existing tests in the repository that might have been affected by the change I made and confirmed that they pass. - Ran the full
packages/core/__tests__suite (377 tests) and the entire monorepo vitest suite (117 test files / 1064 tests), all passing both before and after my changes (aside from one flaky, unrelateddocument is not definedasync teardown error reproducible even on the unmodified baseline).
-
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 →
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 →