@prosekit/extensions 0.0.0-next-20240421132240 → 0.0.0-next-20240427200701

package/dist/_tsup-dts-rollup.d.ts

@@ -16,6 +16,7 @@ import { IndentListOptions } from 'prosemirror-flat-list';
 import { InputRule } from '@prosekit/pm/inputrules';
 import { ListAttributes } from 'prosemirror-flat-list';
 import { ListDOMSerializer } from 'prosemirror-flat-list';
+import { MarkType } from '@prosekit/pm/model';
 import { NodeRange } from 'prosemirror-model';
 import { NodeType } from '@prosekit/pm/model';
 import { Options } from 'tsup';
@@ -28,6 +29,8 @@ import { ToggleCollapsedOptions } from 'prosemirror-flat-list';
 import { Transaction } from '@prosekit/pm/state';
 import { UnwrapListOptions } from 'prosemirror-flat-list';
 
+export declare function applyMarkRules(rules: MarkRule[], transactions: readonly Transaction[], oldState: EditorState, newState: EditorState): Transaction | null;
+
 declare class AutocompleteRule {
     readonly regex: RegExp;
     readonly onMatch: MatchHandler;
@@ -467,6 +470,12 @@ export declare function defineListSpec(): Extension<{
     NODES: "list";
 }>;
 
+/**
+ * A mark rule is something that can automatically apply marks to text if it
+ * matches a certain pattern, and remove them if it doesn't match anymore.
+ */
+export declare function defineMarkRule(options: MarkRuleOptions): Extension<ExtensionTyping<string, string, CommandArgs>>;
+
 /**
  * @public
  */
@@ -758,6 +767,8 @@ export declare type EnterRuleOptions = {
  */
 export declare const exitTable: Command;
 
+export declare function getCheckRanges(transactions: readonly Transaction[], oldState: EditorState, newState: EditorState): Array<[number, number]>;
+
 export { getHighlighter }
 
 export declare function getPluginState(state: EditorState): PredictionPluginState | undefined;
@@ -812,6 +823,42 @@ export declare interface LinkAttrs {
 
 export { ListDOMSerializer }
 
+/**
+ * @internal
+ */
+export declare class MarkRule {
+    readonly regex: RegExp;
+    readonly type: string | MarkType;
+    readonly getAttrs: (match: RegExpMatchArray) => Attrs | null;
+    constructor({ regex, type, attrs }: MarkRuleOptions);
+}
+
+/**
+ * The options for {@link defineMarkRule}.
+ *
+ * @public
+ */
+declare interface MarkRuleOptions {
+    /**
+     * The regular expression to match against. It must has a `g` flag to match
+     * all instances of the mark.
+     */
+    regex: RegExp;
+    /**
+     * The mark type to apply to the matched text.
+     */
+    type: string | MarkType;
+    /**
+     * Attributes to set on the mark. If a function is provided, it will be called
+     * with the matched result from the regular expression.
+     *
+     * @default null
+     */
+    attrs?: Attrs | null | ((match: RegExpMatchArray) => Attrs | null);
+}
+export { MarkRuleOptions }
+export { MarkRuleOptions as MarkRuleOptions_alias_1 }
+
 declare type MatchHandler = (options: {
     state: EditorState;
     match: RegExpExecArray;

package/dist/prosekit-extensions-code-block.js

@@ -1,9 +1,9 @@
-import {
-  defineTextBlockInputRule
-} from "./chunk-DYFRBXUX.js";
 import {
   defineTextBlockEnterRule
 } from "./chunk-ASTUC4KT.js";
+import {
+  defineTextBlockInputRule
+} from "./chunk-DYFRBXUX.js";
 
 // src/code-block/code-block.ts
 import { union } from "@prosekit/core";

package/dist/prosekit-extensions-link.js

@@ -1,9 +1,9 @@
-import {
-  defineInputRule
-} from "./chunk-DYFRBXUX.js";
 import {
   defineEnterRule
 } from "./chunk-ASTUC4KT.js";
+import {
+  defineInputRule
+} from "./chunk-DYFRBXUX.js";
 
 // src/link/index.ts
 import {

package/dist/prosekit-extensions-mark-rule.d.ts

@@ -0,0 +1,2 @@
+export { defineMarkRule } from './_tsup-dts-rollup';
+export { MarkRuleOptions } from './_tsup-dts-rollup';

package/dist/prosekit-extensions-mark-rule.js

@@ -0,0 +1,184 @@
+// src/mark-rule/index.ts
+import { Facet, pluginFacet } from "@prosekit/core";
+import { ProseMirrorPlugin } from "@prosekit/pm/state";
+
+// src/mark-rule/apply.ts
+import { OBJECT_REPLACEMENT_CHARACTER, getMarkType } from "@prosekit/core";
+import "@prosekit/pm/model";
+import "@prosekit/pm/state";
+
+// src/mark-rule/range.ts
+import "@prosekit/pm/state";
+function getSpanTextRanges($from, $to) {
+  const nodeRange = $from.blockRange($to);
+  if (!nodeRange) {
+    return [];
+  }
+  const stack = [];
+  let start = nodeRange.start;
+  for (let i = nodeRange.startIndex; i < nodeRange.endIndex; i++) {
+    const child = nodeRange.parent.child(i);
+    stack.push([start, child]);
+    start += child.nodeSize;
+  }
+  const ranges = [];
+  while (stack.length > 0) {
+    const [start2, node] = stack.pop();
+    if (node.type.spec.code) {
+      continue;
+    }
+    if (node.type.isTextblock) {
+      ranges.push([start2 + 1, start2 + 1 + node.content.size]);
+      continue;
+    }
+    node.forEach((child, offset) => {
+      stack.push([start2 + offset + 1, child]);
+    });
+  }
+  return ranges;
+}
+function getInlineTextRange($from, $to) {
+  return [$from.start(), $to.end()];
+}
+function getTextRanges(doc, from, to) {
+  const $from = doc.resolve(from);
+  const $to = doc.resolve(to);
+  if ($from.sameParent($to) && $from.parent.isTextblock) {
+    return [getInlineTextRange($from, $to)];
+  } else {
+    const nodeRange = $from.blockRange($to);
+    if (!nodeRange) {
+      return [];
+    }
+    return getSpanTextRanges($from, $to);
+  }
+}
+function getMapRange(transactions, oldState, newState) {
+  let lo = oldState.selection.from;
+  let hi = oldState.selection.to;
+  for (const tr of transactions) {
+    for (const map of tr.mapping.maps) {
+      lo = map.map(lo);
+      hi = map.map(hi);
+      map.forEach((_oldStart, _oldEnd, newStart, newEnd) => {
+        lo = Math.min(lo, hi, newStart);
+        hi = Math.max(hi, hi, newEnd);
+      });
+    }
+  }
+  lo = Math.min(lo, hi, newState.selection.from);
+  hi = Math.min(lo, hi, newState.selection.to);
+  return [lo, hi];
+}
+function getCheckRanges(transactions, oldState, newState) {
+  const [from, to] = getMapRange(transactions, oldState, newState);
+  return getTextRanges(newState.doc, from, to);
+}
+
+// src/mark-rule/apply.ts
+function getExpectedMarkings(rules, doc, from, to) {
+  const text = doc.textBetween(from, to, OBJECT_REPLACEMENT_CHARACTER);
+  const result = [];
+  for (const rule of rules) {
+    rule.regex.lastIndex = 0;
+    const matches = text.matchAll(rule.regex);
+    const markType = getMarkType(doc.type.schema, rule.type);
+    for (const match of matches) {
+      const index = match.index;
+      if (index == null)
+        continue;
+      const attrs = rule.getAttrs(match);
+      const mark = markType.create(attrs);
+      result.push([mark, from + index, from + index + match[0].length]);
+    }
+  }
+  return result;
+}
+function getReceivedMarkings(rules, doc, from, to) {
+  const result = [];
+  const schema = doc.type.schema;
+  const markTypes = rules.map((rule) => getMarkType(schema, rule.type));
+  doc.nodesBetween(from, to, (node, pos) => {
+    if (!node.isInline) {
+      return;
+    }
+    for (const markType of markTypes) {
+      const mark = node.marks.find((mark2) => mark2.type === markType);
+      if (mark) {
+        result.push([mark, pos, pos + node.nodeSize]);
+      }
+    }
+  });
+  return result;
+}
+function markingEquals(a, b) {
+  return a[1] === b[1] && a[2] === b[2] && a[0].eq(b[0]);
+}
+function markingDiffs(a, b) {
+  return a.filter((x) => !b.some((y) => markingEquals(x, y)));
+}
+function applyMarkRules(rules, transactions, oldState, newState) {
+  if (transactions.length === 0 || transactions.every((tr2) => !tr2.docChanged)) {
+    return null;
+  }
+  const ranges = getCheckRanges(transactions, oldState, newState);
+  const toRemove = [];
+  const toCreate = [];
+  for (const [from, to] of ranges) {
+    const expected = getExpectedMarkings(rules, newState.doc, from, to);
+    const received = getReceivedMarkings(rules, newState.doc, from, to);
+    toRemove.push(...markingDiffs(received, expected));
+    toCreate.push(...markingDiffs(expected, received));
+  }
+  if (toCreate.length === 0 && toRemove.length === 0) {
+    return null;
+  }
+  const tr = newState.tr;
+  for (const [mark, from, to] of toRemove) {
+    tr.removeMark(from, to, mark);
+  }
+  for (const [mark, from, to] of toCreate) {
+    tr.addMark(from, to, mark);
+  }
+  return tr;
+}
+
+// src/mark-rule/rule.ts
+import "@prosekit/pm/model";
+var MarkRule = class {
+  constructor({ regex, type, attrs = null }) {
+    this.regex = regex;
+    this.type = type;
+    this.getAttrs = typeof attrs === "function" ? attrs : () => attrs;
+  }
+};
+
+// src/mark-rule/index.ts
+function defineMarkRule(options) {
+  return markRuleFacet.extension([new MarkRule(options)]);
+}
+var markRuleFacet = Facet.define({
+  converter: () => {
+    let rules = [];
+    const plugin = new ProseMirrorPlugin({
+      appendTransaction: (transactions, oldState, newState) => {
+        return applyMarkRules(rules, transactions, oldState, newState);
+      }
+    });
+    const pluginFunc = () => [plugin];
+    return {
+      create: (inputs) => {
+        rules = inputs;
+        return pluginFunc;
+      },
+      update: (inputs) => {
+        rules = inputs;
+        return null;
+      }
+    };
+  },
+  next: pluginFacet
+});
+export {
+  defineMarkRule
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@prosekit/extensions",
   "type": "module",
-  "version": "0.0.0-next-20240421132240",
+  "version": "0.0.0-next-20240427200701",
   "private": false,
   "author": {
     "name": "ocavue",
@@ -30,6 +30,11 @@
       "import": "./dist/prosekit-extensions.js",
       "default": "./dist/prosekit-extensions.js"
     },
+    "./mark-rule": {
+      "types": "./dist/prosekit-extensions-mark-rule.d.ts",
+      "import": "./dist/prosekit-extensions-mark-rule.js",
+      "default": "./dist/prosekit-extensions-mark-rule.js"
+    },
     "./autocomplete": {
       "types": "./dist/prosekit-extensions-autocomplete.d.ts",
       "import": "./dist/prosekit-extensions-autocomplete.js",
@@ -147,8 +152,8 @@
     "dist"
   ],
   "dependencies": {
-    "@prosekit/core": "0.0.0-next-20240421132240",
-    "@prosekit/pm": "0.0.0-next-20240421132240",
+    "@prosekit/core": "0.0.0-next-20240427200701",
+    "@prosekit/pm": "0.0.0-next-20240427200701",
     "prosemirror-dropcursor": "^1.8.1",
     "prosemirror-flat-list": "^0.5.0",
     "prosemirror-highlight": "^0.5.0",
@@ -159,7 +164,7 @@
     "@prosekit/dev": "*",
     "tsup": "^8.0.2",
     "typescript": "^5.4.5",
-    "vitest": "^1.5.0"
+    "vitest": "^1.5.2"
   },
   "scripts": {
     "build:tsup": "tsup",
@@ -171,6 +176,9 @@
       ".": [
         "./dist/prosekit-extensions.d.ts"
       ],
+      "mark-rule": [
+        "./dist/prosekit-extensions-mark-rule.d.ts"
+      ],
       "autocomplete": [
         "./dist/prosekit-extensions-autocomplete.d.ts"
       ],