Fix: configured/extended extensions should keep their original config

[tleruitte]

Please describe your changes

Extensions, marks and nodes should keep their original config when they are extended or configured.

How did you accomplish your changes

n/a.

How have you tested your changes

Tested locally.

How can we verify your changes

import Code from '@tiptap/extension-code'
import Document from '@tiptap/extension-document'
import Paragraph from '@tiptap/extension-paragraph'
import Text from '@tiptap/extension-text'
import { EditorContent, useEditor } from '@tiptap/react'
import React from 'react'

export default () => {
  const editor = useEditor({
    extensions: [Document, Paragraph, Text, Code.configure({
      HTMLAttributes: {
        class: 'my-custom-class',
      },
    })],
    content: `
        <p>This isn’t code.</p>
        <p><code>This is code.</code></p>
      `,
  })

  if (!editor) {
    return null
  }

  return (
    <>
      <button
        onClick={() => editor.chain().focus().toggleCode().run()}
        className={editor.isActive('code') ? 'is-active' : ''}
      >
        toggleCode
      </button>
      <button
        onClick={() => editor.chain().focus().setCode().run()}
        disabled={editor.isActive('code')}
      >
        setCode
      </button>
      <button
        onClick={() => editor.chain().focus().unsetCode().run()}
        disabled={!editor.isActive('code')}
      >
        unsetCode
      </button>

      <EditorContent editor={editor} />
    </>
  )
}

Before this fix, the instance of Code doesn't have excludes, code or exitable set. This prevents the right arrow keyboard shortcut to exit the code mark for instance. After the fix, the config is correctly extended and the new instance of Code uses the correct values for excludes, code or exitable. Same goes for Extension and Node.

Remarks

This is especially noticeable when users use the StarterKit. StarterKit configures all extensions with undefined by default, which strips them all from their default config.

Checklist

• The changes are not breaking the editor
• Added tests where possible
• Followed the guidelines
• Fixed linting issues

Related issues

I haven't filed an issue.

[netlify]

✅ Deploy Preview for tiptap-embed ready!

Name	Link
🔨 Latest commit	b5ea1f2
🔍 Latest deploy log	https://app.netlify.com/sites/tiptap-embed/deploys/64a979b1f6115d0008ebcdcf
😎 Deploy Preview	https://deploy-preview-4191--tiptap-embed.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[bdbch]

LGTM - this does not break any functionality while you tested it? @tleruitte

CC @svenadlung - you want to take another look?

[tleruitte]

@bdbch Sorry I missed your comment. No, I didn't see any broken functionality with this fix!

[tleruitte]

@bdbch @svenadlung Let me know if there is anything else I can do to get this merged :)

[rfgamaral]

I'm wondering if this could be something released as v2.1.7 🤔😁

[tleruitte]

I think this got fixed in 2.1.0 by another pull request. https://github.com/ueberdosis/tiptap/releases/tag/v2.1.0

[tleruitte]

Never mind, just tested 2.1.11 and the bug is still present. #3822 only fix configure, but not extend. So I think we stil should merge this pull request. Let me know if/how I can help to get this merged.

[bdbch]

I merged it for now and will release a new RC version with this tomorrow. Would be nice if someone could check it out by then

[romansp]

This appears as fixed in 2.2.0-rc.4.

Any idea why exitable is checked on config directly and not via getExtensionField helper? Though it doesn't seem to be necessary anymore because extension config is preserved now.

tiptap/packages/core/src/ExtensionManager.ts

Lines 240 to 242 in 42039c0

	if (extension.type === 'mark' && extension.config.exitable) {
	defaultBindings.ArrowRight = () => Mark.handleExit({ editor, mark: extension as Mark })
	}

Also maybe exitable should be copied here?

tiptap/packages/core/src/helpers/getSchemaByResolvedExtensions.ts

Lines 145 to 163 in 42039c0

	const schema: MarkSpec = cleanUpSchemaItem({
	...extraMarkFields,
	inclusive: callOrReturn(
	getExtensionField<MarkConfig['inclusive']>(extension, 'inclusive', context),
	),
	excludes: callOrReturn(
	getExtensionField<MarkConfig['excludes']>(extension, 'excludes', context),
	),
	group: callOrReturn(getExtensionField<MarkConfig['group']>(extension, 'group', context)),
	spanning: callOrReturn(
	getExtensionField<MarkConfig['spanning']>(extension, 'spanning', context),
	),
	code: callOrReturn(getExtensionField<MarkConfig['code']>(extension, 'code', context)),
	attrs: Object.fromEntries(
	extensionAttributes.map(extensionAttribute => {
	return [extensionAttribute.name, { default: extensionAttribute?.attribute?.default }]
	}),
	),
	})

[Nantris]

This commit causes #4617. See review comments.