-
-
Notifications
You must be signed in to change notification settings - Fork 2.2k
/
code-block.ts
315 lines (264 loc) · 7.84 KB
/
code-block.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
import { mergeAttributes, Node, textblockTypeInputRule } from '@tiptap/core'
import {
Plugin,
PluginKey,
Selection,
TextSelection,
} from '@tiptap/pm/state'
export interface CodeBlockOptions {
/**
* Adds a prefix to language classes that are applied to code tags.
* @default 'language-'
*/
languageClassPrefix: string
/**
* Define whether the node should be exited on triple enter.
* @default true
*/
exitOnTripleEnter: boolean
/**
* Define whether the node should be exited on arrow down if there is no node after it.
* @default true
*/
exitOnArrowDown: boolean
/**
* Custom HTML attributes that should be added to the rendered HTML tag.
* @default {}
* @example { class: 'foo' }
*/
HTMLAttributes: Record<string, any>
}
declare module '@tiptap/core' {
interface Commands<ReturnType> {
codeBlock: {
/**
* Set a code block
* @param attributes Code block attributes
* @example editor.commands.setCodeBlock({ language: 'javascript' })
*/
setCodeBlock: (attributes?: { language: string }) => ReturnType
/**
* Toggle a code block
* @param attributes Code block attributes
* @example editor.commands.toggleCodeBlock({ language: 'javascript' })
*/
toggleCodeBlock: (attributes?: { language: string }) => ReturnType
}
}
}
/**
* Matches a code block with backticks.
*/
export const backtickInputRegex = /^```([a-z]+)?[\s\n]$/
/**
* Matches a code block with tildes.
*/
export const tildeInputRegex = /^~~~([a-z]+)?[\s\n]$/
/**
* This extension allows you to create code blocks.
* @see https://tiptap.dev/api/nodes/code-block
*/
export const CodeBlock = Node.create<CodeBlockOptions>({
name: 'codeBlock',
addOptions() {
return {
languageClassPrefix: 'language-',
exitOnTripleEnter: true,
exitOnArrowDown: true,
HTMLAttributes: {},
}
},
content: 'text*',
marks: '',
group: 'block',
code: true,
defining: true,
addAttributes() {
return {
language: {
default: null,
parseHTML: element => {
const { languageClassPrefix } = this.options
const classNames = [...(element.firstElementChild?.classList || [])]
const languages = classNames
.filter(className => className.startsWith(languageClassPrefix))
.map(className => className.replace(languageClassPrefix, ''))
const language = languages[0]
if (!language) {
return null
}
return language
},
rendered: false,
},
}
},
parseHTML() {
return [
{
tag: 'pre',
preserveWhitespace: 'full',
},
]
},
renderHTML({ node, HTMLAttributes }) {
return [
'pre',
mergeAttributes(this.options.HTMLAttributes, HTMLAttributes),
[
'code',
{
class: node.attrs.language
? this.options.languageClassPrefix + node.attrs.language
: null,
},
0,
],
]
},
addCommands() {
return {
setCodeBlock:
attributes => ({ commands }) => {
return commands.setNode(this.name, attributes)
},
toggleCodeBlock:
attributes => ({ commands }) => {
return commands.toggleNode(this.name, 'paragraph', attributes)
},
}
},
addKeyboardShortcuts() {
return {
'Mod-Alt-c': () => this.editor.commands.toggleCodeBlock(),
// remove code block when at start of document or code block is empty
Backspace: () => {
const { empty, $anchor } = this.editor.state.selection
const isAtStart = $anchor.pos === 1
if (!empty || $anchor.parent.type.name !== this.name) {
return false
}
if (isAtStart || !$anchor.parent.textContent.length) {
return this.editor.commands.clearNodes()
}
return false
},
// exit node on triple enter
Enter: ({ editor }) => {
if (!this.options.exitOnTripleEnter) {
return false
}
const { state } = editor
const { selection } = state
const { $from, empty } = selection
if (!empty || $from.parent.type !== this.type) {
return false
}
const isAtEnd = $from.parentOffset === $from.parent.nodeSize - 2
const endsWithDoubleNewline = $from.parent.textContent.endsWith('\n\n')
if (!isAtEnd || !endsWithDoubleNewline) {
return false
}
return editor
.chain()
.command(({ tr }) => {
tr.delete($from.pos - 2, $from.pos)
return true
})
.exitCode()
.run()
},
// exit node on arrow down
ArrowDown: ({ editor }) => {
if (!this.options.exitOnArrowDown) {
return false
}
const { state } = editor
const { selection, doc } = state
const { $from, empty } = selection
if (!empty || $from.parent.type !== this.type) {
return false
}
const isAtEnd = $from.parentOffset === $from.parent.nodeSize - 2
if (!isAtEnd) {
return false
}
const after = $from.after()
if (after === undefined) {
return false
}
const nodeAfter = doc.nodeAt(after)
if (nodeAfter) {
return editor.commands.command(({ tr }) => {
tr.setSelection(Selection.near(doc.resolve(after)))
return true
})
}
return editor.commands.exitCode()
},
}
},
addInputRules() {
return [
textblockTypeInputRule({
find: backtickInputRegex,
type: this.type,
getAttributes: match => ({
language: match[1],
}),
}),
textblockTypeInputRule({
find: tildeInputRegex,
type: this.type,
getAttributes: match => ({
language: match[1],
}),
}),
]
},
addProseMirrorPlugins() {
return [
// this plugin creates a code block for pasted content from VS Code
// we can also detect the copied code language
new Plugin({
key: new PluginKey('codeBlockVSCodeHandler'),
props: {
handlePaste: (view, event) => {
if (!event.clipboardData) {
return false
}
// don’t create a new code block within code blocks
if (this.editor.isActive(this.type.name)) {
return false
}
const text = event.clipboardData.getData('text/plain')
const vscode = event.clipboardData.getData('vscode-editor-data')
const vscodeData = vscode ? JSON.parse(vscode) : undefined
const language = vscodeData?.mode
if (!text || !language) {
return false
}
const { tr, schema } = view.state
// prepare a text node
// strip carriage return chars from text pasted as code
// see: https://github.com/ProseMirror/prosemirror-view/commit/a50a6bcceb4ce52ac8fcc6162488d8875613aacd
const textNode = schema.text(text.replace(/\r\n?/g, '\n'))
// create a code block with the text node
// replace selection with the code block
tr.replaceSelectionWith(this.type.create({ language }, textNode))
if (tr.selection.$from.parent.type !== this.type) {
// put cursor inside the newly created code block
tr.setSelection(TextSelection.near(tr.doc.resolve(Math.max(0, tr.selection.from - 2))))
}
// store meta information
// this is useful for other plugins that depends on the paste event
// like the paste rule plugin
tr.setMeta('paste', true)
view.dispatch(tr)
return true
},
},
}),
]
},
})