@prosekit/core 0.8.6 → 0.8.7

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@prosekit/core",
   "type": "module",
-  "version": "0.8.6",
+  "version": "0.8.7",
   "private": false,
   "description": "Core features for ProseKit",
   "author": {
@@ -52,11 +52,12 @@
   "devDependencies": {
     "@types/diffable-html": "^5.0.2",
     "diffable-html": "^6.0.1",
-    "tsdown": "^0.16.2",
+    "tsdown": "^0.16.5",
     "typescript": "~5.9.3",
-    "vitest": "^4.0.8",
-    "@prosekit/config-vitest": "0.0.0",
-    "@prosekit/config-tsdown": "0.0.0"
+    "vitest": "^4.0.10",
+    "vitest-browser-commands": "^0.2.0",
+    "@prosekit/config-tsdown": "0.0.0",
+    "@prosekit/config-vitest": "0.0.0"
   },
   "publishConfig": {
     "dev": {}

package/src/extensions/keymap.spec.ts

@@ -5,10 +5,17 @@ import {
   it,
   vi,
 } from 'vitest'
+import { keyboard } from 'vitest-browser-commands/playwright'
 
 import { union } from '../editor/union'
 import { withPriority } from '../editor/with-priority'
-import { setupTest } from '../testing'
+import {
+  defineDoc,
+  defineParagraph,
+  defineText,
+  setupTest,
+  setupTestFromExtension,
+} from '../testing'
 import { Priority } from '../types/priority'
 
 import {
@@ -122,4 +129,66 @@ describe('keymap', () => {
     // Highest priority should be called first
     expect(callOrder).toEqual(['highest', 'default', 'lowest'])
   })
+
+  it('can merge keybindings with different variants', async () => {
+    const called: string[] = []
+    const { editor } = setupTestFromExtension(union(
+      defineDoc(),
+      defineText(),
+      defineParagraph(),
+    ))
+
+    const record = (label: string): Command => {
+      return () => {
+        called.push(label)
+        return false
+      }
+    }
+
+    const keybindings = [
+      // Match Ctrl-b
+      'ctrl-b',
+      'CTRL-b',
+
+      // Match Ctrl-Shift-b
+      'c-B',
+      'ctrl-shift-b',
+      'c-s-B',
+      'Ctrl-B',
+
+      // Do not match
+      'ctrl-c',
+    ]
+    const keymap: Keymap = Object.fromEntries(keybindings.map(binding => [binding, record(binding)]))
+
+    editor.use(defineKeymap(keymap))
+
+    called.length = 0
+    await keyboard.down('Control')
+    await keyboard.down('b')
+    await keyboard.up('b')
+    await keyboard.up('Control')
+    expect(called).toMatchInlineSnapshot(`
+      [
+        "ctrl-b",
+        "CTRL-b",
+      ]
+    `)
+
+    called.length = 0
+    await keyboard.down('Control')
+    await keyboard.down('Shift')
+    await keyboard.down('B')
+    await keyboard.up('B')
+    await keyboard.up('Shift')
+    await keyboard.up('Control')
+    expect(called).toMatchInlineSnapshot(`
+      [
+        "c-s-B",
+        "c-B",
+        "Ctrl-B",
+        "ctrl-shift-b",
+      ]
+    `)
+  })
 })

package/src/extensions/keymap.ts

@@ -15,6 +15,7 @@ import {
 import { defineFacetPayload } from '../facets/facet-extension'
 import type { PlainExtension } from '../types/extension'
 import { toReversed } from '../utils/array'
+import { isApple } from '../utils/env'
 
 import {
   pluginFacet,
@@ -22,6 +23,9 @@ import {
 } from './plugin'
 
 /**
+ * A set of keybindings. Please read the
+ * [documentation](https://prosemirror.net/docs/ref/#keymap) for more details.
+ *
  * @public
  */
 export interface Keymap {
@@ -29,6 +33,9 @@ export interface Keymap {
 }
 
 /**
+ * Adds a set of keybindings to the editor. Please read the
+ * [documentation](https://prosemirror.net/docs/ref/#keymap) for more details.
+ *
  * @public
  */
 export function defineKeymap(keymap: Keymap): PlainExtension {
@@ -81,7 +88,8 @@ function mergeKeymaps(keymaps: Keymap[]): Keymap {
 
   for (const keymap of keymaps) {
     for (const [key, command] of Object.entries(keymap)) {
-      const commands = bindings[key] || (bindings[key] = [])
+      const normalizedKey = normalizeKeyName(key)
+      const commands = bindings[normalizedKey] ||= []
       commands.push(command)
     }
   }
@@ -93,4 +101,27 @@ function mergeCommands(commands: Command[]): Command {
   return chainCommands(...commands)
 }
 
+// Copied from https://github.com/ProseMirror/prosemirror-keymap/blob/1.2.3/src/keymap.ts#L8
+function normalizeKeyName(name: string) {
+  let parts = name.split(/-(?!$)/), result = parts[parts.length - 1]
+  if (result == 'Space') result = ' '
+  let alt, ctrl, shift, meta
+  for (let i = 0; i < parts.length - 1; i++) {
+    let mod = parts[i]
+    if (/^(cmd|meta|m)$/i.test(mod)) meta = true
+    else if (/^a(lt)?$/i.test(mod)) alt = true
+    else if (/^(c|ctrl|control)$/i.test(mod)) ctrl = true
+    else if (/^s(hift)?$/i.test(mod)) shift = true
+    else if (/^mod$/i.test(mod)) {
+      if (isApple) meta = true
+      else ctrl = true
+    } else throw new Error('Unrecognized modifier name: ' + mod)
+  }
+  if (alt) result = 'Alt-' + result
+  if (ctrl) result = 'Ctrl-' + result
+  if (meta) result = 'Meta-' + result
+  if (shift) result = 'Shift-' + result
+  return result
+}
+
 const keymapPluginKey = new PluginKey('prosekit-keymap')

package/src/utils/env.ts

@@ -1,4 +1,6 @@
 /**
+ * https://github.com/ProseMirror/prosemirror-keymap/blob/1.2.3/src/keymap.ts#L5
+ *
  * @internal
  */
 export const isApple: boolean = typeof navigator !== 'undefined'