replace NodeExtension with Node, replace MarkExtension with Mark

2020-11-16 11:19:43 +01:00
parent b44aafa97c
commit 8a7603edaf
31 changed files with 105 additions and 99 deletions
--- a/packages/core/src/Mark.ts
+++ b/packages/core/src/Mark.ts
@@ -0,0 +1,170 @@
+import {
+  DOMOutputSpec,
+  MarkSpec,
+  Mark as ProseMirrorMark,
+  MarkType,
+} from 'prosemirror-model'
+import { Plugin } from 'prosemirror-state'
+import { ExtensionSpec } from './Extension'
+import { Attributes, Overwrite } from './types'
+import { Editor } from './Editor'
+
+export interface MarkExtensionSpec<Options = any, Commands = {}> extends Overwrite<ExtensionSpec<Options, Commands>, {
+  /**
+   * Inclusive
+   */
+  inclusive?: MarkSpec['inclusive'] | ((this: { options: Options }) => MarkSpec['inclusive']),
+
+  /**
+   * Excludes
+   */
+  excludes?: MarkSpec['excludes'] | ((this: { options: Options }) => MarkSpec['excludes']),
+
+  /**
+   * Group
+   */
+  group?: MarkSpec['group'] | ((this: { options: Options }) => MarkSpec['group']),
+
+  /**
+   * Spanning
+   */
+  spanning?: MarkSpec['spanning'] | ((this: { options: Options }) => MarkSpec['spanning']),
+
+  /**
+   * Parse HTML
+   */
+  parseHTML?: (
+    this: {
+      options: Options,
+    },
+  ) => MarkSpec['parseDOM'],
+
+  /**
+   * Render HTML
+   */
+  renderHTML?: ((
+    this: {
+      options: Options,
+    },
+    props: {
+      mark: ProseMirrorMark,
+      HTMLAttributes: { [key: string]: any },
+    }
+  ) => DOMOutputSpec) | null,
+
+  /**
+   * Attributes
+   */
+  addAttributes?: (
+    this: {
+      options: Options,
+    },
+  ) => Attributes,
+
+  /**
+   * Commands
+   */
+  addCommands?: (this: {
+    options: Options,
+    editor: Editor,
+    type: MarkType,
+  }) => Commands,
+
+  /**
+   * Keyboard shortcuts
+   */
+  addKeyboardShortcuts?: (this: {
+    options: Options,
+    editor: Editor,
+    type: MarkType,
+  }) => {
+    [key: string]: any
+  },
+
+  /**
+   * Input rules
+   */
+  addInputRules?: (this: {
+    options: Options,
+    editor: Editor,
+    type: MarkType,
+  }) => any[],
+
+  /**
+   * Paste rules
+   */
+  addPasteRules?: (this: {
+    options: Options,
+    editor: Editor,
+    type: MarkType,
+  }) => any[],
+
+  /**
+   * ProseMirror plugins
+   */
+  addProseMirrorPlugins?: (this: {
+    options: Options,
+    editor: Editor,
+    type: MarkType,
+  }) => Plugin[],
+}> {}
+
+export class Mark<Options = any, Commands = {}> {
+  config: Required<MarkExtensionSpec> = {
+    name: 'mark',
+    defaultOptions: {},
+    addGlobalAttributes: () => [],
+    addCommands: () => ({}),
+    addKeyboardShortcuts: () => ({}),
+    addInputRules: () => [],
+    addPasteRules: () => [],
+    addProseMirrorPlugins: () => [],
+    inclusive: null,
+    excludes: null,
+    group: null,
+    spanning: null,
+    parseHTML: () => null,
+    renderHTML: null,
+    addAttributes: () => ({}),
+  }
+
+  options!: Options
+
+  constructor(config: MarkExtensionSpec<Options, Commands>) {
+    this.config = {
+      ...this.config,
+      ...config,
+    }
+
+    this.options = this.config.defaultOptions
+  }
+
+  static create<O, C>(config: MarkExtensionSpec<O, C>) {
+    return new Mark<O, C>(config)
+  }
+
+  configure(options: Partial<Options>) {
+    return Mark
+      .create<Options, Commands>(this.config as MarkExtensionSpec<Options, Commands>)
+      .#configure({
+        ...this.config.defaultOptions,
+        ...options,
+      })
+  }
+
+  #configure = (options: Partial<Options>) => {
+    this.options = {
+      ...this.config.defaultOptions,
+      ...options,
+    }
+
+    return this
+  }
+
+  extend<ExtendedOptions = Options, ExtendedCommands = Commands>(extendedConfig: Partial<MarkExtensionSpec<ExtendedOptions, ExtendedCommands>>) {
+    return new Mark<ExtendedOptions, ExtendedCommands>({
+      ...this.config,
+      ...extendedConfig,
+    } as MarkExtensionSpec<ExtendedOptions, ExtendedCommands>)
+  }
+}