add basic new syntax

This commit is contained in:
Philipp Kühn
2020-10-21 15:17:05 +02:00
parent 36fd2b70c7
commit 020483f0b2
10 changed files with 249 additions and 110 deletions

View File

@@ -56,6 +56,8 @@ module.exports = {
'no-param-reassign': 'off', 'no-param-reassign': 'off',
'import/prefer-default-export': 'off', 'import/prefer-default-export': 'off',
'consistent-return': 'off', 'consistent-return': 'off',
'no-redeclare': 'off',
'@typescript-eslint/no-redeclare': ['error'],
'no-unused-vars': 'off', 'no-unused-vars': 'off',
'@typescript-eslint/no-unused-vars': ['error'], '@typescript-eslint/no-unused-vars': ['error'],
'no-use-before-define': 'off', 'no-use-before-define': 'off',

View File

@@ -3,10 +3,12 @@ import { Editor, Command, CommandsSpec } from './src/Editor'
export default Editor export default Editor
export { Editor, Command, CommandsSpec } export { Editor, Command, CommandsSpec }
export { default as ComponentRenderer } from './src/ComponentRenderer' export { default as ComponentRenderer } from './src/ComponentRenderer'
export { default as Extension } from './src/Extension' // export { default as Extension } from './src/Extension'
export { default as Node } from './src/Node' // export { default as Node } from './src/Node'
export * from './src/Extension'
export * from './src/Node' export * from './src/Node'
export { default as Mark } from './src/Mark' export * from './src/Mark'
// export { default as Mark } from './src/Mark'
export { Extensions } from './src/types' export { Extensions } from './src/types'
export { default as nodeInputRule } from './src/inputRules/nodeInputRule' export { default as nodeInputRule } from './src/inputRules/nodeInputRule'

View File

@@ -113,27 +113,55 @@
// } // }
// } // }
export default class Extension<Options = {}> { export interface Extension {
type: string,
name: string,
options: {
[key: string]: any
},
createCommands(): {
[key: string]: any
},
}
name = 'extension' export interface ExtensionSpec<Options, Commands> {
name: string,
type = 'extension' defaultOptions?: Options,
createCommands?(this: {
options: Partial<Options> = {} options: Options,
// editor: Editor,
constructor(options?: Partial<Options>) { }): Commands,
this.options = { }
...this.createDefaultOptions(),
...options,
}
}
createDefaultOptions() {
return {}
}
const defaultExtension: Extension = {
type: 'extension',
name: 'extension',
options: {},
createCommands() { createCommands() {
return {} return {}
},
}
export function createExtension<Options extends {}, Commands extends {}>(config: ExtensionSpec<Options, Commands>) {
const extend = <ExtendedOptions = Options, ExtendedCommands = Commands>(extendedConfig: Partial<ExtensionSpec<ExtendedOptions, ExtendedCommands>>) => {
return createExtension({
...config,
...extendedConfig,
} as ExtensionSpec<ExtendedOptions, ExtendedCommands>)
} }
const setOptions = (options?: Partial<Options>) => {
const { defaultOptions, ...rest } = config
return {
...defaultExtension,
...rest,
options: {
...defaultOptions,
...options,
} as Options,
}
}
return Object.assign(setOptions, { config, extend })
} }

View File

@@ -27,22 +27,22 @@
// } // }
// } // }
import Extension from './Extension' // import Extension from './Extension'
export default class Node<Options = {}> extends Extension<Options> { // export default class Node<Options = {}> extends Extension<Options> {
type = 'mark' // type = 'mark'
createAttributes() { // createAttributes() {
return {} // return {}
} // }
parseHTML() { // parseHTML() {
return [] // return []
} // }
renderHTML() { // renderHTML() {
return [] // return []
} // }
} // }

View File

@@ -32,39 +32,113 @@
// } // }
// } // }
import { DOMOutputSpec, DOMOutputSpecArray } from 'prosemirror-model' // import { DOMOutputSpec, DOMOutputSpecArray } from 'prosemirror-model'
import Extension from './Extension' // import Extension from './Extension'
export interface INode { // export interface INode {
type: string // type: string
topNode: boolean // topNode: boolean
group: string // group: string
content: string // content: string
createAttributes(): any // createAttributes(): any
parseHTML(): any // parseHTML(): any
renderHTML(props: number): DOMOutputSpec // renderHTML(props: number): DOMOutputSpec
// }
// export default class Node<Options = {}> extends Extension<Options> implements INode {
// type = 'node'
// topNode = false
// group = ''
// content = ''
// createAttributes() {
// return {}
// }
// parseHTML() {
// return []
// }
// renderHTML() {
// return null
// }
// }
import { DOMOutputSpec, NodeSpec, Node } from 'prosemirror-model'
import { Extension, ExtensionSpec } from './Extension'
export interface NodeExtension extends Extension {
topNode: boolean,
content: NodeSpec['content'],
marks: NodeSpec['marks'],
group: NodeSpec['group'],
inline: NodeSpec['inline'],
atom: NodeSpec['atom'],
parseHTML: () => NodeSpec['parseDOM'],
renderHTML: (props: {
node: Node,
attributes: {
[key: string]: any,
},
}) => DOMOutputSpec,
} }
export default class Node<Options = {}> extends Extension<Options> implements INode { export interface NodeExtensionSpec<Options, Commands> extends ExtensionSpec<Options, Commands> {
topNode?: boolean,
type = 'node' content?: NodeSpec['content'],
marks?: NodeSpec['marks'],
topNode = false group?: NodeSpec['group'],
inline?: NodeSpec['inline'],
group = '' atom?: NodeSpec['atom'],
parseHTML?: () => NodeSpec['parseDOM'],
content = '' renderHTML?: (props: {
node: Node,
createAttributes() { attributes: {
return {} [key: string]: any,
} },
}) => DOMOutputSpec,
parseHTML() { }
return []
} const defaultNode: NodeExtension = {
type: 'node',
renderHTML() { name: 'node',
return null options: {},
} topNode: false,
content: null,
marks: null,
group: null,
inline: null,
atom: null,
createCommands: () => ({}),
parseHTML: () => null,
renderHTML: () => null,
}
export function createNode<Options extends {}, Commands extends {}>(config: NodeExtensionSpec<Options, Commands>) {
const extend = <ExtendedOptions = Options, ExtendedCommands = Commands>(extendedConfig: Partial<NodeExtensionSpec<ExtendedOptions, ExtendedCommands>>) => {
return createNode({
...config,
...extendedConfig,
} as NodeExtensionSpec<ExtendedOptions, ExtendedCommands>)
}
const setOptions = (options?: Partial<Options>) => {
const { defaultOptions, ...rest } = config
return {
...defaultNode,
...rest,
options: {
...defaultOptions,
...options,
} as Options,
}
}
return Object.assign(setOptions, { config, extend })
} }

View File

@@ -5,32 +5,28 @@ import getTopNodeFromExtensions from './getTopNodeFromExtensions'
import getNodesFromExtensions from './getNodesFromExtensions' import getNodesFromExtensions from './getNodesFromExtensions'
import getMarksFromExtensions from './getMarksFromExtensions' import getMarksFromExtensions from './getMarksFromExtensions'
import resolveExtensionConfig from './resolveExtensionConfig' import resolveExtensionConfig from './resolveExtensionConfig'
import Node from '../Node' import { Node } from '../Node'
import Mark from '../Mark' import Mark from '../Mark'
import Extension from '../Extension' import Extension from '../Extension'
export default function getSchema(extensions: Extensions): Schema { export default function getSchema(extensions: Extensions): Schema {
const baseExtensions = extensions.filter(extension => extension.type === 'extension') as Extension[] // const baseExtensions = extensions.filter(extension => extension.type === 'extension') as Extension[]
const nodeExtensions = extensions.filter(extension => extension.type === 'node') as Node[] const nodeExtensions = extensions.filter(extension => extension.type === 'node') as Node[]
const markExtensions = extensions.filter(extension => extension.type === 'mark') as Mark[] // const markExtensions = extensions.filter(extension => extension.type === 'mark') as Mark[]
// console.log({ extensions })
const nodes = Object.fromEntries(nodeExtensions.map(extension => { const nodes = Object.fromEntries(nodeExtensions.map(extension => {
const schema: NodeSpec = { const schema: NodeSpec = {
content: extension.content, content: extension.content,
group: extension.group, group: extension.group,
parseDOM: extension.parseHTML(), parseDOM: extension.parseHTML(),
toDOM: node => extension.renderHTML({ node, attributes: { class: 'hee' } }), toDOM: node => extension.renderHTML({ node, attributes: { class: 'test' } }),
} }
return [ return [extension.name, schema]
extension.name,
schema,
]
})) }))
console.log({ nodes })
const topNode = nodeExtensions.find(extension => extension.topNode)?.name const topNode = nodeExtensions.find(extension => extension.topNode)?.name
// extensions.forEach(extension => { // extensions.forEach(extension => {
@@ -57,8 +53,5 @@ export default function getSchema(extensions: Extensions): Schema {
topNode, topNode,
nodes, nodes,
marks: {}, marks: {},
// topNode: getTopNodeFromExtensions(extensions),
// nodes: getNodesFromExtensions(extensions),
// marks: getMarksFromExtensions(extensions),
}) })
} }

View File

@@ -1,4 +1,4 @@
import { Node } from '@tiptap/core' import { createNode } from '@tiptap/core'
// export default new Node() // export default new Node()
// .name('document') // .name('document')
@@ -8,12 +8,20 @@ import { Node } from '@tiptap/core'
// })) // }))
// .create() // .create()
export default class Document extends Node { // export default class Document extends Node {
name = 'document' // name = 'document'
topNode = true // topNode = true
content = 'block+' // content = 'block+'
} // }
export default createNode({
name: 'document',
topNode: true,
content: 'block+',
})

View File

@@ -1,5 +1,5 @@
import { Command, Node, INode } from '@tiptap/core' import { createNode } from '@tiptap/core'
import { DOMOutputSpecArray } from 'prosemirror-model' // import { DOMOutputSpecArray } from 'prosemirror-model'
// import ParagraphComponent from './paragraph.vue' // import ParagraphComponent from './paragraph.vue'
// export type ParagraphCommand = () => Command // export type ParagraphCommand = () => Command
@@ -29,31 +29,49 @@ import { DOMOutputSpecArray } from 'prosemirror-model'
// })) // }))
// .create() // .create()
export default class Paragraph extends Node implements INode { // export default class Paragraph extends Node implements INode {
name = 'paragraph' // name = 'paragraph'
group = 'block' // group = 'block'
content = 'inline*' // content = 'inline*'
createAttributes() { // createAttributes() {
return { // return {
// default rendering // // default rendering
class: { // class: {
default: 'jooo', // default: 'jooo',
}, // },
} // }
} // }
// parseHTML() {
// return [
// { tag: 'p' },
// ]
// }
// renderHTML() {
// return ['p', 0] as const
// }
// }
export default createNode({
name: 'paragraph',
group: 'block',
content: 'inline*',
parseHTML() { parseHTML() {
return [ return [
{ tag: 'p' }, { tag: 'p' },
] ]
} },
renderHTML() { renderHTML({ attributes }) {
return ['p', 0] as const return ['p', attributes, 0]
} },
})
}

View File

@@ -1,4 +1,4 @@
import { Node } from '@tiptap/core' import { createNode } from '@tiptap/core'
// export default new Node() // export default new Node()
// .name('text') // .name('text')
@@ -7,10 +7,16 @@ import { Node } from '@tiptap/core'
// })) // }))
// .create() // .create()
export default class Text extends Node { // export default class Text extends Node {
name = 'text' // name = 'text'
group = 'inline' // group = 'inline'
} // }
export default createNode({
name: 'text',
group: 'inline',
})

View File

@@ -1,8 +1,16 @@
// import originalDefaultExtensions from '@tiptap/starter-kit' // import originalDefaultExtensions from '@tiptap/starter-kit'
import Document from '@tiptap/extension-document'
import Text from '@tiptap/extension-text'
import Paragraph from '@tiptap/extension-paragraph'
export * from '@tiptap/vue' export * from '@tiptap/vue'
export function defaultExtensions() { export function defaultExtensions() {
return [] return [
Document(),
Text(),
Paragraph(),
]
// return originalDefaultExtensions() // return originalDefaultExtensions()
} }