@prosekit/extensions 0.13.0 → 0.14.1

package/src/enter-rule/index.ts

@@ -1,113 +1,28 @@
+import { defineFacet, defineFacetPayload, pluginFacet, type PlainExtension, type PluginPayload } from '@prosekit/core'
 import {
-  defineFacet,
-  defineFacetPayload,
-  getNodeType,
-  isTextSelection,
-  maybeRun,
-  OBJECT_REPLACEMENT_CHARACTER,
-  pluginFacet,
-  type PlainExtension,
-  type PluginPayload,
-} from '@prosekit/core'
-import { keydownHandler } from '@prosekit/pm/keymap'
-import type {
-  Attrs,
-  NodeType,
-} from '@prosekit/pm/model'
-import {
-  PluginKey,
-  ProseMirrorPlugin,
-  type Command,
-  type EditorState,
-  type Transaction,
-} from '@prosekit/pm/state'
-import type { EditorView } from '@prosekit/pm/view'
+  createEnterRulePlugin,
+  createTextBlockEnterRule,
+  type EnterRule,
+  type EnterRuleHandler,
+  type EnterRuleHandlerOptions,
+  type TextBlockEnterRuleOptions as _TextBlockEnterRuleOptions,
+} from 'prosemirror-enter-rules'
 
-/**
- * @public
- *
- * Options for {@link EnterRuleHandler}.
- */
-export interface EnterRuleHandlerOptions {
-  /**
-   * The current editor state.
-   */
-  state: EditorState
-
-  /**
-   * The start position of the matched text.
-   */
-  from: number
-
-  /**
-   * The end position of the matched text.
-   */
-  to: number
-
-  /**
-   * The matched result from the regular expression.
-   */
-  match: RegExpExecArray
-}
-
-/**
- * @public
- */
-export type EnterRuleHandler = (options: EnterRuleHandlerOptions) => Transaction | null
+export type { EnterRuleHandler, EnterRuleHandlerOptions }
 
 /**
  * Options for {@link defineEnterRule}.
  *
  * @public
  */
-export type EnterRuleOptions = {
-  /**
-   * The regular expression to match against. It should end with `$`.
-   */
-  regex: RegExp
-
-  /**
-   * A function to be called when an enter rule is triggered.
-   */
-  handler: EnterRuleHandler
-
-  /**
-   * Whether to stop further handlers from being called if this rule is triggered.
-   *
-   * @default false
-   */
-  stop?: boolean
-}
+export type EnterRuleOptions = EnterRule
 
 /**
  * Options for {@link defineTextBlockEnterRule}.
  *
  * @public
  */
-export interface TextBlockEnterRuleOptions {
-  /**
-   * The regular expression to match against. It should end with `$`.
-   */
-  regex: RegExp
-
-  /**
-   * The node type to replace the matched text with.
-   */
-  type: string | NodeType
-
-  /**
-   * Attributes to set on the node. If a function is provided, it will be called
-   * with the matched result from the regular expression.
-   */
-  attrs?: Attrs | null | ((match: RegExpMatchArray) => Attrs | null)
-
-  /**
-   * Whether to stop further handlers from being called if this rule is triggered.
-   *
-   * @default true
-   */
-  stop?: boolean
-}
+export type TextBlockEnterRuleOptions = _TextBlockEnterRuleOptions
 
 /**
  * Defines an enter rule. An enter rule applies when the text directly in front of
@@ -118,13 +33,8 @@ export interface TextBlockEnterRuleOptions {
  *
  * @public
  */
-export function defineEnterRule({
-  regex,
-  handler,
-  stop = false,
-}: EnterRuleOptions): PlainExtension {
-  const rule: EnterRule = new EnterRule(regex, handler, stop)
-  return defineFacetPayload(enterRule, [rule]) as PlainExtension
+export function defineEnterRule(options: EnterRuleOptions): PlainExtension {
+  return defineFacetPayload(enterRuleFacet, [options]) as PlainExtension
 }
 
 /**
@@ -136,106 +46,14 @@ export function defineEnterRule({
  *
  * @public
  */
-export function defineTextBlockEnterRule({
-  regex,
-  type,
-  attrs,
-  stop = true,
-}: TextBlockEnterRuleOptions): PlainExtension {
-  return defineEnterRule({
-    regex,
-    handler: ({ state, from, to, match }) => {
-      const nodeType = getNodeType(state.schema, type)
-      const $start = state.doc.resolve(from)
-
-      if (
-        !$start
-          .node(-1)
-          .canReplaceWith($start.index(-1), $start.indexAfter(-1), nodeType)
-      ) {
-        return null
-      }
-
-      const nodeAttrs = maybeRun(attrs, match)
-      return state.tr
-        .delete(from, to)
-        .setBlockType(from, from, nodeType, nodeAttrs)
-    },
-    stop,
-  })
-}
-
-/**
- * @internal
- */
-class EnterRule {
-  constructor(
-    readonly regex: RegExp,
-    readonly handler: EnterRuleHandler,
-    readonly stop: boolean,
-  ) {}
+export function defineTextBlockEnterRule(options: TextBlockEnterRuleOptions): PlainExtension {
+  return defineEnterRule(createTextBlockEnterRule(options))
 }
 
-const enterRule = defineFacet<EnterRule, PluginPayload>({
-  reduce: () => {
-    let rules: EnterRule[] = []
-
-    const command: Command = (state, dispatch, view) => {
-      if (!view) return false
-      return execRules(view, rules, dispatch)
-    }
-    const handler = keydownHandler({ Enter: command })
-    const plugin = new ProseMirrorPlugin({
-      key: new PluginKey('prosekit-enter-rule'),
-      props: { handleKeyDown: handler },
-    })
-
-    return function reducer(inputs) {
-      rules = inputs
-      return plugin
-    }
+const enterRuleFacet = defineFacet<EnterRule, PluginPayload>({
+  reducer: (rules: EnterRule[]): PluginPayload => {
+    return createEnterRulePlugin({ rules })
   },
 
   parent: pluginFacet,
 })
-
-function execRules(
-  view: EditorView,
-  rules: readonly EnterRule[],
-  dispatch?: (tr: Transaction) => void,
-): boolean {
-  if (view.composing) return false
-  const state = view.state
-  const selection = state.selection
-  if (!isTextSelection(selection)) return false
-  const $cursor = selection.$cursor
-  if (!$cursor || $cursor.parent.type.spec.code) return false
-
-  const textBefore = $cursor.parent.textBetween(
-    Math.max(0, $cursor.parentOffset - MAX_MATCH),
-    $cursor.parentOffset,
-    null,
-    OBJECT_REPLACEMENT_CHARACTER,
-  )
-
-  for (const rule of rules) {
-    rule.regex.lastIndex = 0
-    const match = rule.regex.exec(textBefore)
-    const tr = match
-      && rule.handler({
-        state,
-        from: $cursor.pos - match[0].length,
-        to: $cursor.pos,
-        match,
-      })
-    if (!tr) continue
-    dispatch?.(tr)
-
-    if (rule.stop) {
-      return true
-    }
-  }
-  return false
-}
-
-const MAX_MATCH = 200

package/src/file/file-paste-handler.spec.ts

@@ -1,20 +1,7 @@
-import {
-  Priority,
-  union,
-  withPriority,
-} from '@prosekit/core'
-import {
-  beforeEach,
-  describe,
-  expect,
-  it,
-  vi,
-} from 'vitest'
+import { Priority, union, withPriority } from '@prosekit/core'
+import { beforeEach, describe, expect, it, vi } from 'vitest'
 
-import {
-  defineTestExtension,
-  setupTestFromExtension,
-} from '../testing'
+import { defineTestExtension, setupTestFromExtension } from '../testing'
 import { pasteFiles } from '../testing/clipboard'
 
 import { defineFilePasteHandler } from './file-paste-handler'

package/src/file/index.ts

@@ -1,16 +1,3 @@
-export {
-  defineFileDropHandler,
-  type FileDropHandler,
-  type FileDropHandlerOptions,
-} from './file-drop-handler'
-export {
-  defineFilePasteHandler,
-  type FilePasteHandler,
-  type FilePasteHandlerOptions,
-} from './file-paste-handler'
-export {
-  UploadTask,
-  type Uploader,
-  type UploaderOptions,
-  type UploadProgress,
-} from './file-upload'
+export { defineFileDropHandler, type FileDropHandler, type FileDropHandlerOptions } from './file-drop-handler'
+export { defineFilePasteHandler, type FilePasteHandler, type FilePasteHandlerOptions } from './file-paste-handler'
+export { UploadTask, type Uploader, type UploaderOptions, type UploadProgress } from './file-upload'

package/src/gap-cursor/gap-cursor.ts

@@ -1,7 +1,4 @@
-import {
-  definePlugin,
-  type PlainExtension,
-} from '@prosekit/core'
+import { definePlugin, type PlainExtension } from '@prosekit/core'
 import { gapCursor } from 'prosemirror-gapcursor'
 
 /**

package/src/gap-cursor/index.ts

@@ -1,4 +1 @@
-export {
-  defineGapCursor,
-  type GapCursorExtension,
-} from './gap-cursor'
+export { defineGapCursor, type GapCursorExtension } from './gap-cursor'

package/src/hard-break/hard-break-commands.ts

@@ -1,8 +1,4 @@
-import {
-  defineCommands,
-  insertNode,
-  type Extension,
-} from '@prosekit/core'
+import { defineCommands, insertNode, type Extension } from '@prosekit/core'
 import type { Command } from '@prosekit/pm/state'
 
 /**

package/src/hard-break/hard-break-keymap.spec.ts

@@ -1,8 +1,4 @@
-import {
-  describe,
-  expect,
-  it,
-} from 'vitest'
+import { describe, expect, it } from 'vitest'
 import { keyboard } from 'vitest-browser-commands/playwright'
 
 import { setupTest } from '../testing'

package/src/hard-break/hard-break-keymap.ts

@@ -1,7 +1,4 @@
-import {
-  defineKeymap,
-  type PlainExtension,
-} from '@prosekit/core'
+import { defineKeymap, type PlainExtension } from '@prosekit/core'
 
 import { insertHardBreak } from './hard-break-commands'
 

package/src/hard-break/hard-break-spec.ts

@@ -1,7 +1,4 @@
-import {
-  defineNodeSpec,
-  type Extension,
-} from '@prosekit/core'
+import { defineNodeSpec, type Extension } from '@prosekit/core'
 import type { Attrs } from '@prosekit/pm/model'
 
 /**

package/src/hard-break/hard-break.ts

@@ -1,17 +1,8 @@
-import {
-  union,
-  type Union,
-} from '@prosekit/core'
+import { union, type Union } from '@prosekit/core'
 
-import {
-  defineHardBreakCommands,
-  type HardBreakCommandsExtension,
-} from './hard-break-commands'
+import { defineHardBreakCommands, type HardBreakCommandsExtension } from './hard-break-commands'
 import { defineHardBreakKeymap } from './hard-break-keymap'
-import {
-  defineHardBreakSpec,
-  type HardBreakSpecExtension,
-} from './hard-break-spec'
+import { defineHardBreakSpec, type HardBreakSpecExtension } from './hard-break-spec'
 
 /**
  * @internal

package/src/hard-break/index.ts

@@ -1,13 +1,4 @@
-export {
-  defineHardBreak,
-  type HardBreakExtension,
-} from './hard-break'
-export {
-  defineHardBreakCommands,
-  type HardBreakCommandsExtension,
-} from './hard-break-commands'
+export { defineHardBreak, type HardBreakExtension } from './hard-break'
+export { defineHardBreakCommands, type HardBreakCommandsExtension } from './hard-break-commands'
 export { defineHardBreakKeymap } from './hard-break-keymap'
-export {
-  defineHardBreakSpec,
-  type HardBreakSpecExtension,
-} from './hard-break-spec'
+export { defineHardBreakSpec, type HardBreakSpecExtension } from './hard-break-spec'

package/src/heading/heading-commands.ts

@@ -1,10 +1,4 @@
-import {
-  defineCommands,
-  insertNode,
-  setBlockType,
-  toggleNode,
-  type Extension,
-} from '@prosekit/core'
+import { defineCommands, insertNode, setBlockType, toggleNode, type Extension } from '@prosekit/core'
 
 import type { HeadingAttrs } from './heading-types'
 

package/src/heading/heading-keymap.spec.ts

@@ -1,8 +1,4 @@
-import {
-  describe,
-  expect,
-  it,
-} from 'vitest'
+import { describe, expect, it } from 'vitest'
 import { keyboard } from 'vitest-browser-commands/playwright'
 
 import { setupTest } from '../testing'

package/src/heading/heading-keymap.ts

@@ -1,11 +1,4 @@
-import {
-  defineKeymap,
-  isAtBlockStart,
-  toggleNode,
-  unsetBlockType,
-  withSkipCodeBlock,
-  type PlainExtension,
-} from '@prosekit/core'
+import { defineKeymap, isAtBlockStart, toggleNode, unsetBlockType, withSkipCodeBlock, type PlainExtension } from '@prosekit/core'
 import type { Command } from '@prosekit/pm/state'
 
 function toggleHeadingKeybinding(level: number): Command {

package/src/heading/heading-spec.ts

@@ -1,7 +1,4 @@
-import {
-  defineNodeSpec,
-  type Extension,
-} from '@prosekit/core'
+import { defineNodeSpec, type Extension } from '@prosekit/core'
 
 import type { HeadingAttrs } from './heading-types'
 

package/src/heading/heading.ts

@@ -1,18 +1,9 @@
-import {
-  union,
-  type Union,
-} from '@prosekit/core'
+import { union, type Union } from '@prosekit/core'
 
-import {
-  defineHeadingCommands,
-  type HeadingCommandsExtension,
-} from './heading-commands'
+import { defineHeadingCommands, type HeadingCommandsExtension } from './heading-commands'
 import { defineHeadingInputRule } from './heading-input-rule'
 import { defineHeadingKeymap } from './heading-keymap'
-import {
-  defineHeadingSpec,
-  type HeadingSpecExtension,
-} from './heading-spec'
+import { defineHeadingSpec, type HeadingSpecExtension } from './heading-spec'
 
 /**
  * @internal

package/src/heading/index.ts

@@ -1,15 +1,6 @@
-export {
-  defineHeading,
-  type HeadingExtension,
-} from './heading'
-export {
-  defineHeadingCommands,
-  type HeadingCommandsExtension,
-} from './heading-commands'
+export { defineHeading, type HeadingExtension } from './heading'
+export { defineHeadingCommands, type HeadingCommandsExtension } from './heading-commands'
 export { defineHeadingInputRule } from './heading-input-rule'
 export { defineHeadingKeymap } from './heading-keymap'
-export {
-  defineHeadingSpec,
-  type HeadingSpecExtension,
-} from './heading-spec'
+export { defineHeadingSpec, type HeadingSpecExtension } from './heading-spec'
 export type { HeadingAttrs } from './heading-types'

package/src/horizontal-rule/horizontal-rule-commands.spec.ts

@@ -1,8 +1,4 @@
-import {
-  describe,
-  expect,
-  it,
-} from 'vitest'
+import { describe, expect, it } from 'vitest'
 
 import { setupTest } from '../testing'
 

package/src/horizontal-rule/horizontal-rule-commands.ts

@@ -1,12 +1,5 @@
-import {
-  defineCommands,
-  getNodeType,
-  type Extension,
-} from '@prosekit/core'
-import {
-  Fragment,
-  Slice,
-} from '@prosekit/pm/model'
+import { defineCommands, getNodeType, type Extension } from '@prosekit/core'
+import { Fragment, Slice } from '@prosekit/pm/model'
 import type { Command } from '@prosekit/pm/state'
 
 export type HorizontalRuleCommandsExtension = Extension<{

package/src/horizontal-rule/horizontal-rule-input-rule.spec.ts

@@ -1,15 +1,11 @@
-import {
-  describe,
-  expect,
-  it,
-} from 'vitest'
+import { describe, expect, it } from 'vitest'
 
 import { setupTest } from '../testing'
 import { inputText } from '../testing/keyboard'
 
 describe('defineHorizontalRuleInputRule', () => {
   const { editor, n } = setupTest()
-  it('should insert a horizontal rule when typing "---" in an empty paragraph', async () => {
+  it('should insert when typing "---" in an empty paragraph', async () => {
     const doc = n.doc(n.p('<a>'))
     editor.set(doc)
 
@@ -24,7 +20,7 @@ describe('defineHorizontalRuleInputRule', () => {
     )
   })
 
-  it('should insert a horizontal rule when typing "---"  before some text', async () => {
+  it('should insert when typing "---"  before some text', async () => {
     const doc = n.doc(n.p('<a>123'))
     editor.set(doc)
 
@@ -39,7 +35,7 @@ describe('defineHorizontalRuleInputRule', () => {
     )
   })
 
-  it('should not insert a horizontal rule when typing "---"  after some text', async () => {
+  it('should not insert when typing "---"  after some text', async () => {
     const doc = n.doc(n.p('123<a>'))
     editor.set(doc)
 
@@ -49,7 +45,7 @@ describe('defineHorizontalRuleInputRule', () => {
     )
   })
 
-  it('should not insert a horizontal rule inside a code block', async () => {
+  it('should not insert inside a code block', async () => {
     const doc = n.doc(n.codeBlock('<a>'))
     editor.set(doc)
 

package/src/horizontal-rule/horizontal-rule-input-rule.ts

@@ -1,8 +1,4 @@
-import {
-  getNodeType,
-  union,
-  type PlainExtension,
-} from '@prosekit/core'
+import { getNodeType, union, type PlainExtension } from '@prosekit/core'
 import { InputRule } from '@prosekit/pm/inputrules'
 
 import { defineInputRule } from '../input-rule'

package/src/horizontal-rule/horizontal-rule-spec.ts

@@ -1,7 +1,4 @@
-import {
-  defineNodeSpec,
-  type Extension,
-} from '@prosekit/core'
+import { defineNodeSpec, type Extension } from '@prosekit/core'
 import type { Attrs } from '@prosekit/pm/model'
 
 export type HorizontalRuleSpecExtension = Extension<{

package/src/horizontal-rule/horizontal-rule.ts

@@ -1,17 +1,8 @@
-import {
-  union,
-  type Union,
-} from '@prosekit/core'
+import { union, type Union } from '@prosekit/core'
 
-import {
-  defineHorizontalRuleCommands,
-  type HorizontalRuleCommandsExtension,
-} from './horizontal-rule-commands'
+import { defineHorizontalRuleCommands, type HorizontalRuleCommandsExtension } from './horizontal-rule-commands'
 import { defineHorizontalRuleInputRule } from './horizontal-rule-input-rule'
-import {
-  defineHorizontalRuleSpec,
-  type HorizontalRuleSpecExtension,
-} from './horizontal-rule-spec'
+import { defineHorizontalRuleSpec, type HorizontalRuleSpecExtension } from './horizontal-rule-spec'
 
 export type HorizontalRuleExtension = Union<
   [HorizontalRuleSpecExtension, HorizontalRuleCommandsExtension]

package/src/horizontal-rule/index.ts

@@ -1,14 +1,4 @@
-export {
-  defineHorizontalRule,
-  type HorizontalRuleExtension,
-} from './horizontal-rule'
-export {
-  defineHorizontalRuleCommands,
-  insertHorizontalRule,
-  type HorizontalRuleCommandsExtension,
-} from './horizontal-rule-commands'
+export { defineHorizontalRule, type HorizontalRuleExtension } from './horizontal-rule'
+export { defineHorizontalRuleCommands, insertHorizontalRule, type HorizontalRuleCommandsExtension } from './horizontal-rule-commands'
 export { defineHorizontalRuleInputRule } from './horizontal-rule-input-rule'
-export {
-  defineHorizontalRuleSpec,
-  type HorizontalRuleSpecExtension,
-} from './horizontal-rule-spec'
+export { defineHorizontalRuleSpec, type HorizontalRuleSpecExtension } from './horizontal-rule-spec'