fix(core): Can() does not work for setting marks (#3223)

Previously, setting marks did no schema validation checks for dry runs
(like the `.can()` command). The `setMark` raw command will now properly
check if the mark is possible to be set given the editor node/mark
schema.

Co-authored-by: Cameron Hessler <cameron.hessler@buildertrend.com>
This commit is contained in:
Cameron Hessler
2022-09-26 07:56:25 -05:00
committed by GitHub
parent 8c088b6b88
commit 17a41da5a7
6 changed files with 313 additions and 12 deletions

View File

@@ -1,6 +1,9 @@
/// <reference types="cypress" />
import { Editor } from '@tiptap/core'
import Bold from '@tiptap/extension-bold'
import Code from '@tiptap/extension-code'
import CodeBlock from '@tiptap/extension-code-block'
import Document from '@tiptap/extension-document'
import History from '@tiptap/extension-history'
import Paragraph from '@tiptap/extension-paragraph'
@@ -70,4 +73,174 @@ describe('can', () => {
expect(canUndo).to.eq(true)
})
it('returns false for non-applicable marks when selection contains node in conflict', () => {
const editor = new Editor({
extensions: [
Document,
Paragraph,
Text,
History,
CodeBlock,
Bold,
],
})
editor.chain()
.setCodeBlock()
.insertContent('Test code block')
.setTextSelection({ from: 2, to: 3 })
.selectAll()
.run()
const canSetMarkToBold = editor.can().setMark('bold')
expect(canSetMarkToBold).to.eq(false)
})
it('returns false for non-applicable marks when selection contains marks in conflict', () => {
const editor = new Editor({
extensions: [
Document,
Paragraph,
Text,
History,
Code,
Bold,
],
})
editor.chain()
.setContent('<code>test</code>')
.setTextSelection({ from: 2, to: 3 })
.run()
const canSetMarkToBold = editor.can().setMark('bold')
expect(canSetMarkToBold).to.eq(false)
})
it('returns false for non-applicable marks when stored marks in conflict', () => {
const editor = new Editor({
extensions: [
Document,
Paragraph,
Text,
History,
Code,
Bold,
],
})
editor.chain().setContent('<code>test</code>').run()
const canSetMarkToBold = editor.can().setMark('bold')
expect(canSetMarkToBold).to.eq(false)
})
it('returns false for non-applicable marks when selecting multiple nodes in conflict', () => {
const editor = new Editor({
extensions: [
Document,
Paragraph,
Text,
History,
Code,
Bold,
],
})
editor.chain().setContent('<code>test</code><code>123</code>').selectAll().run()
const canSetMarkToBold = editor.can().setMark('bold')
expect(canSetMarkToBold).to.eq(false)
})
it('returns true for applicable marks when selection does not contain nodes in conflict', () => {
const editor = new Editor({
extensions: [
Document,
Paragraph,
Text,
History,
CodeBlock,
Bold,
],
})
editor.chain()
.setCodeBlock()
.insertContent('Test code block')
.exitCode()
.insertContent('Additional paragraph node')
.selectAll()
.run()
const canSetMarkToBold = editor.can().setMark('bold')
expect(canSetMarkToBold).to.eq(true)
})
it('returns true for applicable marks when stored marks are not in conflict', () => {
const editor = new Editor({
extensions: [
Document,
Paragraph,
Text,
History,
Code,
Bold,
],
})
editor.chain().setContent('<code>test</code>').toggleCode().run()
const canSetMarkToBold = editor.can().setMark('bold')
expect(canSetMarkToBold).to.eq(true)
})
it('returns true for applicable marks when selection does not contain marks in conflict', () => {
const editor = new Editor({
extensions: [
Document,
Paragraph,
Text,
History,
Code,
Bold,
],
})
editor.chain()
.setContent('<code>test</code>')
.setTextSelection({ from: 2, to: 3 })
.toggleCode()
.run()
const canSetMarkToBold = editor.can().setMark('bold')
expect(canSetMarkToBold).to.eq(true)
})
it('returns true for applicable marks if at least one node in selection has no marks in conflict', () => {
const editor = new Editor({
extensions: [
Document,
Paragraph,
Text,
History,
Code,
Bold,
],
})
editor.chain().setContent('<code>test</code><i>123</i>').selectAll().run()
const canSetMarkToBold = editor.can().setMark('bold')
expect(canSetMarkToBold).to.eq(true)
})
})