Skip to content

Commit

Permalink
fix: fix order of executed plugins, fix #1547
Browse files Browse the repository at this point in the history
  • Loading branch information
philippkuehn committed Oct 3, 2021
1 parent dc868b3 commit f8efdf7
Show file tree
Hide file tree
Showing 2 changed files with 75 additions and 2 deletions.
8 changes: 6 additions & 2 deletions packages/core/src/ExtensionManager.ts
Original file line number Diff line number Diff line change
Expand Up @@ -205,8 +205,12 @@ export default class ExtensionManager {
}

get plugins(): Plugin[] {
return [...this.extensions]
.reverse()
// With ProseMirror, first plugins within an array are executed first.
// In tiptap, we provide the ability to override plugins,
// so it feels more natural to run plugins at the end of an array first.
// That’s why we have to reverse the `extensions` array and sort again
// based on the `priority` option.
return ExtensionManager.sort([...this.extensions].reverse())
.map(extension => {
const context = {
name: extension.name,
Expand Down
69 changes: 69 additions & 0 deletions tests/cypress/integration/core/pluginOrder.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
/// <reference types="cypress" />

import { Editor, Extension } from '@tiptap/core'
import Document from '@tiptap/extension-document'
import Paragraph from '@tiptap/extension-paragraph'
import Text from '@tiptap/extension-text'

describe('pluginOrder', () => {
it('should run keyboard shortcuts in correct order', () => {
const order: number[] = []

cy.window().then(({ document }) => {
const element = document.createElement('div')

document.body.append(element)

const editor = new Editor({
element,
extensions: [
Document,
Paragraph,
Text,
Extension.create({
priority: 1000,
addKeyboardShortcuts() {
return {
a: () => {
order.push(1)

return false
},
}
},
}),
Extension.create({
addKeyboardShortcuts() {
return {
a: () => {
order.push(3)

return false
},
}
},
}),
Extension.create({
addKeyboardShortcuts() {
return {
a: () => {
order.push(2)

return false
},
}
},
}),
],
})

cy.get('.ProseMirror')
.type('a')
.wait(100).then(() => {
expect(order).to.deep.eq([1, 2, 3])

editor.destroy()
})
})
})
})

0 comments on commit f8efdf7

Please sign in to comment.