Replace defaultOptions with addOptions

demos/src/Experiments/CollaborationAnnotation/Vue/extension/collaboration-annotation.ts

@@ -59,20 +59,22 @@ declare module '@tiptap/core' {
   }
 }
 
-export const CollaborationAnnotation = Extension.create({
+export const CollaborationAnnotation = Extension.create<AnnotationOptions>({
   name: 'annotation',
 
   priority: 1000,
 
-  defaultOptions: <AnnotationOptions>{
-    HTMLAttributes: {
-      class: 'annotation',
-    },
-    onUpdate: decorations => decorations,
-    document: null,
-    field: 'annotations',
-    map: null,
-    instance: '',
+  addOptions() {
+    return {
+      HTMLAttributes: {
+        class: 'annotation',
+      },
+      onUpdate: decorations => decorations,
+      document: null,
+      field: 'annotations',
+      map: null,
+      instance: '',
+    }
   },
 
   onCreate() {

demos/src/Experiments/Commands/Vue/commands.js

@@ -2,16 +2,17 @@ import { Extension } from '@tiptap/core'
 import Suggestion from '@tiptap/suggestion'
 
 export default Extension.create({
-  name: 'mention',
+  name: 'commands',
 
-  defaultOptions: {
-    suggestion: {
-      char: '/',
-      startOfLine: false,
-      command: ({ editor, range, props }) => {
-        props.command({ editor, range })
+  addOptions() {
+    return {
+      suggestion: {
+        char: '/',
+        command: ({ editor, range, props }) => {
+          props.command({ editor, range })
+        },
       },
-    },
+    }
   },
 
   addProseMirrorPlugins() {

demos/src/Experiments/Details/Vue/details-summary.ts

@@ -17,8 +17,10 @@ export default Node.create<DetailsSummaryOptions>({
 
   isolating: true,
 
-  defaultOptions: {
-    HTMLAttributes: {},
+  addOptions() {
+    return {
+      HTMLAttributes: {},
+    }
   },
 
   parseHTML() {

demos/src/Experiments/Details/Vue/details.ts

@@ -34,8 +34,10 @@ export default Node.create<DetailsOptions>({
 
   // defining: true,
 
-  defaultOptions: {
-    HTMLAttributes: {},
+  addOptions() {
+    return {
+      HTMLAttributes: {},
+    }
   },
 
   parseHTML() {

demos/src/Experiments/Embeds/Vue/iframe.ts

@@ -18,18 +18,20 @@ declare module '@tiptap/core' {
   }
 }
 
-export default Node.create({
+export default Node.create<IframeOptions>({
   name: 'iframe',
 
   group: 'block',
 
   atom: true,
 
-  defaultOptions: <IframeOptions>{
-    allowFullscreen: true,
-    HTMLAttributes: {
-      class: 'iframe-wrapper',
-    },
+  addOptions() {
+    return {
+      allowFullscreen: true,
+      HTMLAttributes: {
+        class: 'iframe-wrapper',
+      },
+    }
   },
 
   addAttributes() {

demos/src/Experiments/Figure/Vue/figure.ts

@@ -41,8 +41,10 @@ export const inputRegex = /!\[(.+|:?)]\((\S+)(?:(?:\s+)["'](\S+)["'])?\)/
 export const Figure = Node.create<FigureOptions>({
   name: 'figure',
 
-  defaultOptions: {
-    HTMLAttributes: {},
+  addOptions() {
+    return {
+      HTMLAttributes: {},
+    }
   },
 
   group: 'block',

demos/src/Experiments/GenericFigure/Vue/figcaption.ts

@@ -3,8 +3,10 @@ import { Node, mergeAttributes } from '@tiptap/core'
 export const Figcaption = Node.create({
   name: 'figcaption',
 
-  defaultOptions: {
-    HTMLAttributes: {},
+  addOptions() {
+    return {
+      HTMLAttributes: {},
+    }
   },
 
   content: 'inline*',

demos/src/Experiments/GenericFigure/Vue/figure.ts

@@ -4,8 +4,10 @@ import { Plugin } from 'prosemirror-state'
 export const Figure = Node.create({
   name: 'figure',
 
-  defaultOptions: {
-    HTMLAttributes: {},
+  addOptions() {
+    return {
+      HTMLAttributes: {},
+    }
   },
 
   group: 'block',

demos/src/Experiments/Linter/Vue/extension/Linter.ts

@@ -39,11 +39,13 @@ export interface LinterOptions {
   plugins: Array<typeof LinterPlugin>,
 }
 
-export const Linter = Extension.create({
+export const Linter = Extension.create<LinterOptions>({
   name: 'linter',
 
-  defaultOptions: <LinterOptions>{
-    plugins: [],
+  addOptions() {
+    return {
+      plugins: [],
+    }
   },
 
   addProseMirrorPlugins() {

demos/src/Experiments/TrailingNode/Vue/trailing-node.ts

@@ -20,11 +20,13 @@ export interface TrailingNodeOptions {
 export const TrailingNode = Extension.create<TrailingNodeOptions>({
   name: 'trailingNode',
 
-  defaultOptions: {
-    node: 'paragraph',
-    notAfter: [
-      'paragraph',
-    ],
+  addOptions() {
+    return {
+      node: 'paragraph',
+      notAfter: [
+        'paragraph',
+      ],
+    }
   },
 
   addProseMirrorPlugins() {

docs/guide/custom-extensions.md

@@ -71,9 +71,11 @@ All settings can be configured through the extension anyway, but if you want to
 import Heading from '@tiptap/extension-heading'
 
 const CustomHeading = Heading.extend({
-  defaultOptions: {
-    ...Heading.options,
-    levels: [1, 2, 3],
+  addOptions() {
+    return {
+      ...this.parent(),
+      levels: [1, 2, 3],
+    }
   },
 })
 ```

docs/guide/typescript.md

@@ -26,8 +26,10 @@ export interface CustomExtensionOptions {
 }
 
 const CustomExtension = Extension.create<CustomExtensionOptions>({
-  defaultOptions: {
-    awesomeness: 100,
+  addOptions() {
+    return {
+      awesomeness: 100,
+    }
   },
 })
 ```

docs/overview/upgrade-guide.md

@@ -103,7 +103,7 @@ import { Node } from '@tiptap/core'
 
 const CustomExtension = Node.create({
   name: 'custom_extension',
-  defaultOptions: {
+  addOptions() {
     …
   },
   addAttributes() {

packages/core/src/Extension.ts

@@ -36,13 +36,21 @@ declare module '@tiptap/core' {
      */
     defaultOptions?: Options,
 
+    /**
+     * Default Options
+     */
+    addOptions?: (this: {
+      name: string,
+      parent: Exclude<ParentConfig<ExtensionConfig<Options, Storage>>['addOptions'], undefined>,
+    }) => Options,
+
     /**
      * Default Storage
      */
     addStorage?: (this: {
       name: string,
       options: Options,
-      parent: ParentConfig<ExtensionConfig<Options, Storage>>['addGlobalAttributes'],
+      parent: Exclude<ParentConfig<ExtensionConfig<Options, Storage>>['addStorage'], undefined>,
     }) => Storage,
 
     /**
@@ -278,15 +286,32 @@ export class Extension<Options = any, Storage = any> {
     }
 
     this.name = this.config.name
+
+    if (config.defaultOptions) {
+      console.warn(`[tiptap warn]: BREAKING CHANGE: "defaultOptions" is deprecated. Please use "addOptions" instead. Found in extension: "${this.name}".`)
+    }
+
+    // TODO: remove `addOptions` fallback
     this.options = this.config.defaultOptions
+
+    if (this.config.addOptions) {
+      this.options = callOrReturn(getExtensionField<AnyConfig['addOptions']>(
+        this,
+        'addOptions',
+        {
+          name: this.name,
+        },
+      ))
+    }
+
     this.storage = callOrReturn(getExtensionField<AnyConfig['addStorage']>(
       this,
       'addStorage',
       {
         name: this.name,
         options: this.options,
       },
-    ))
+    )) || {}
   }
 
   static create<O = any, S = any>(config: Partial<ExtensionConfig<O, S>> = {}) {
@@ -323,10 +348,25 @@ export class Extension<Options = any, Storage = any> {
       ? extendedConfig.name
       : extension.parent.name
 
+    if (extendedConfig.defaultOptions) {
+      console.warn(`[tiptap warn]: BREAKING CHANGE: "defaultOptions" is deprecated. Please use "addOptions" instead. Found in extension: "${extension.name}".`)
+    }
+
+    // TODO: remove `addOptions` fallback
     extension.options = extendedConfig.defaultOptions
       ? extendedConfig.defaultOptions
       : extension.parent.options
 
+    if (extendedConfig.addOptions) {
+      extension.options = callOrReturn(getExtensionField<AnyConfig['addOptions']>(
+        extension,
+        'addOptions',
+        {
+          name: extension.name,
+        },
+      ))
+    }
+
     extension.storage = callOrReturn(getExtensionField<AnyConfig['addStorage']>(
       extension,
       'addStorage',

packages/core/src/Mark.ts

@@ -42,13 +42,21 @@ declare module '@tiptap/core' {
      */
     defaultOptions?: Options,
 
+    /**
+     * Default Options
+     */
+    addOptions?: (this: {
+      name: string,
+      parent: Exclude<ParentConfig<MarkConfig<Options, Storage>>['addOptions'], undefined>,
+    }) => Options,
+
     /**
      * Default Storage
      */
-     addStorage?: (this: {
+    addStorage?: (this: {
       name: string,
       options: Options,
-      parent: ParentConfig<MarkConfig<Options, Storage>>['addGlobalAttributes'],
+      parent: Exclude<ParentConfig<MarkConfig<Options, Storage>>['addStorage'], undefined>,
     }) => Storage,
 
     /**
@@ -392,15 +400,32 @@ export class Mark<Options = any, Storage = any> {
     }
 
     this.name = this.config.name
+
+    if (config.defaultOptions) {
+      console.warn(`[tiptap warn]: BREAKING CHANGE: "defaultOptions" is deprecated. Please use "addOptions" instead. Found in extension: "${this.name}".`)
+    }
+
+    // TODO: remove `addOptions` fallback
     this.options = this.config.defaultOptions
+
+    if (this.config.addOptions) {
+      this.options = callOrReturn(getExtensionField<AnyConfig['addOptions']>(
+        this,
+        'addOptions',
+        {
+          name: this.name,
+        },
+      ))
+    }
+
     this.storage = callOrReturn(getExtensionField<AnyConfig['addStorage']>(
       this,
       'addStorage',
       {
         name: this.name,
         options: this.options,
       },
-    ))
+    )) || {}
   }
 
   static create<O = any, S = any>(config: Partial<MarkConfig<O, S>> = {}) {
@@ -437,10 +462,25 @@ export class Mark<Options = any, Storage = any> {
       ? extendedConfig.name
       : extension.parent.name
 
+    if (extendedConfig.defaultOptions) {
+      console.warn(`[tiptap warn]: BREAKING CHANGE: "defaultOptions" is deprecated. Please use "addOptions" instead. Found in extension: "${extension.name}".`)
+    }
+
+    // TODO: remove `addOptions` fallback
     extension.options = extendedConfig.defaultOptions
       ? extendedConfig.defaultOptions
       : extension.parent.options
 
+    if (extendedConfig.addOptions) {
+      extension.options = callOrReturn(getExtensionField<AnyConfig['addOptions']>(
+        extension,
+        'addOptions',
+        {
+          name: extension.name,
+        },
+      ))
+    }
+
     extension.storage = callOrReturn(getExtensionField<AnyConfig['addStorage']>(
       extension,
       'addStorage',