@prosekit/extensions 0.3.2 → 0.4.1

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

@@ -1,10 +1,16 @@
 import { Attrs } from '@prosekit/pm/model';
-import type { BundledTheme } from 'shikiji';
+import { BundledLanguage } from 'shiki';
+import { BundledLanguageInfo } from 'shiki';
+import { bundledLanguagesInfo } from 'shiki';
+import { BundledTheme } from 'shiki';
+import { BundledThemeInfo } from 'shiki';
+import { bundledThemesInfo } from 'shiki';
 import { CommandArgs } from '@prosekit/core';
 import { DedentListOptions } from 'prosemirror-flat-list';
 import { EditorState } from '@prosekit/pm/state';
 import { Extension } from '@prosekit/core';
 import { ExtensionTyping } from '@prosekit/core';
+import { getHighlighter } from 'shiki/bundle/full';
 import { IndentListOptions } from 'prosemirror-flat-list';
 import { InputRule } from '@prosekit/pm/inputrules';
 import { ListAttributes } from 'prosemirror-flat-list';
@@ -16,6 +22,7 @@ import { Parser } from 'prosemirror-highlight';
 import { Plugin as Plugin_2 } from '@prosekit/pm/state';
 import { PluginKey } from '@prosekit/pm/state';
 import { ProseMirrorNode } from '@prosekit/pm/model';
+import type { SpecialLanguage } from 'shiki';
 import { ToggleCollapsedOptions } from 'prosemirror-flat-list';
 import { Transaction } from '@prosekit/pm/state';
 import { UnwrapListOptions } from 'prosemirror-flat-list';
@@ -39,6 +46,24 @@ declare class AutocompleteRule {
 export { AutocompleteRule }
 export { AutocompleteRule as AutocompleteRule_alias_1 }
 
+export { BundledLanguage as ShikiBundledLanguage }
+export { BundledLanguage as ShikiBundledLanguage_alias_1 }
+
+export { BundledLanguageInfo as ShikiBundledLanguageInfo }
+export { BundledLanguageInfo as ShikiBundledLanguageInfo_alias_1 }
+
+export { bundledLanguagesInfo as shikiBundledLanguagesInfo }
+export { bundledLanguagesInfo as shikiBundledLanguagesInfo_alias_1 }
+
+export { BundledTheme as ShikiBundledTheme }
+export { BundledTheme as ShikiBundledTheme_alias_1 }
+
+export { BundledThemeInfo as ShikiBundledThemeInfo }
+export { BundledThemeInfo as ShikiBundledThemeInfo_alias_1 }
+
+export { bundledThemesInfo as shikiBundledThemesInfo }
+export { bundledThemesInfo as shikiBundledThemesInfo_alias_1 }
+
 /**
  * The attributes for the `codeBlock` node.
  *
@@ -50,10 +75,39 @@ declare interface CodeBlockAttrs {
 export { CodeBlockAttrs }
 export { CodeBlockAttrs as CodeBlockAttrs_alias_1 }
 
+/**
+ * @public
+ */
+export declare interface CodeBlockShikiOptions {
+    /**
+     * Theme registation
+     *
+     * @default ['one-dark-pro']
+     */
+    themes?: BundledTheme[];
+    /**
+     * Language registation
+     *
+     * @default ['text']
+     */
+    langs?: (BundledLanguage | SpecialLanguage)[];
+    /**
+     * Alias of languages
+     *
+     * @example { 'my-lang': 'javascript' }
+     */
+    langAlias?: Record<string, BundledLanguage>;
+}
+
 export declare function createAutocompletePlugin({ getRules, }: {
     getRules: () => AutocompleteRule[];
 }): Plugin_2;
 
+/**
+ * @internal
+ */
+export declare function createLazyParser(highlighterOptions: HighlighterOptions): Parser;
+
 export declare const default_alias: Options | Options[] | ((overrideOptions: Options) => Options | Options[] | Promise<Options | Options[]>);
 
 export declare const default_alias_1: {
@@ -128,7 +182,7 @@ toggleCode: [];
  *
  * @public
  */
-export declare function defineCodeBlock(): Extension<    {
+declare function defineCodeBlock(): Extension<    {
 NODES: "codeBlock";
 COMMAND_ARGS: {
 setCodeBlock: [attrs?: CodeBlockAttrs | undefined];
@@ -137,6 +191,8 @@ toggleCodeBlock: [attrs?: CodeBlockAttrs | undefined];
 setCodeBlockAttrs: [attrs: CodeBlockAttrs];
 };
 }>;
+export { defineCodeBlock }
+export { defineCodeBlock as defineCodeBlock_alias_1 }
 
 /**
  * Adds commands for working with `codeBlock` nodes.
@@ -192,20 +248,13 @@ export { defineCodeBlockInputRule as defineCodeBlockInputRule_alias_1 }
 export declare function defineCodeBlockKeymap(): Extension<ExtensionTyping<string, string, CommandArgs>>;
 
 /**
- * Adds syntax highlighting to code blocks using the [shikiji](https://github.com/antfu/shikiji) package.
+ * Adds syntax highlighting to code blocks using the [shiki](https://github.com/shikijs/shiki) package.
  *
  * @public
  */
-declare function defineCodeBlockShikiji(options?: {
-    /**
-     * The shikiji theme to use.
-     *
-     * @default 'one-dark-pro'
-     */
-    theme?: BundledTheme;
-}): Extension;
-export { defineCodeBlockShikiji }
-export { defineCodeBlockShikiji as defineCodeBlockShikiji_alias_1 }
+declare function defineCodeBlockShiki({ themes, langs, langAlias, }?: CodeBlockShikiOptions): Extension;
+export { defineCodeBlockShiki }
+export { defineCodeBlockShiki as defineCodeBlockShiki_alias_1 }
 
 /**
  * Defines the `codeBlock` node spec.
@@ -590,14 +639,26 @@ export declare interface DropCursorOptions {
  * @public
  */
 export declare type EnterRuleHandler = (options: {
+    /**
+     * 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;
 }) => Transaction | null;
 
 /**
- * Options for {@link createEnterRule}.
+ * Options for {@link defineEnterRule}.
  *
  * @public
  */
@@ -607,7 +668,7 @@ export declare type EnterRuleOptions = {
      */
     regex: RegExp;
     /**
-     * A handler function to be called when an enter rule is triggered.
+     * A function to be called when an enter rule is triggered.
      */
     handler: EnterRuleHandler;
     /**
@@ -618,6 +679,8 @@ export declare type EnterRuleOptions = {
     stop?: boolean;
 };
 
+export { getHighlighter }
+
 export declare function getPluginState(state: EditorState): PredictionPluginState | undefined;
 
 export declare function getTrMeta(tr: Transaction): PredictionPluginState;
@@ -626,6 +689,12 @@ export declare interface HeadingAttrs {
     level: number;
 }
 
+declare type HighlighterOptions = {
+    themes: BundledTheme[];
+    langs: (BundledLanguage | SpecialLanguage)[];
+    langAlias?: Record<string, BundledLanguage>;
+};
+
 /**
  * @public
  *
@@ -700,7 +769,7 @@ export declare interface PredictionPluginState {
 export declare function setTrMeta(tr: Transaction, meta: PredictionPluginState): Transaction;
 
 /**
- * Options for {@link createTextBlockEnterRule}.
+ * Options for {@link defineTextBlockEnterRule}.
  *
  * @public
  */
@@ -714,7 +783,8 @@ export declare type TextBlockEnterRuleOptions = {
      */
     type: string | NodeType;
     /**
-     * Attributes to set on the node.
+     * 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);
     /**

package/dist/prosekit-extensions-code-block.d.ts

@@ -1,9 +1,15 @@
-export { defineCodeBlock } from './_tsup-dts-rollup';
+export { defineCodeBlock_alias_1 as defineCodeBlock } from './_tsup-dts-rollup';
 export { defineCodeBlockCommands_alias_1 as defineCodeBlockCommands } from './_tsup-dts-rollup';
-export { defineCodeBlockEnterRule_alias_1 as defineCodeBlockEnterRule } from './_tsup-dts-rollup';
 export { defineCodeBlockHighlight_alias_1 as defineCodeBlockHighlight } from './_tsup-dts-rollup';
+export { HighlightParser_alias_1 as HighlightParser } from './_tsup-dts-rollup';
+export { defineCodeBlockEnterRule_alias_1 as defineCodeBlockEnterRule } from './_tsup-dts-rollup';
 export { defineCodeBlockInputRule_alias_1 as defineCodeBlockInputRule } from './_tsup-dts-rollup';
-export { defineCodeBlockShikiji_alias_1 as defineCodeBlockShikiji } from './_tsup-dts-rollup';
+export { defineCodeBlockShiki_alias_1 as defineCodeBlockShiki } from './_tsup-dts-rollup';
 export { defineCodeBlockSpec_alias_1 as defineCodeBlockSpec } from './_tsup-dts-rollup';
 export { CodeBlockAttrs_alias_1 as CodeBlockAttrs } from './_tsup-dts-rollup';
-export { HighlightParser_alias_1 as HighlightParser } from './_tsup-dts-rollup';
+export { shikiBundledLanguagesInfo } from './_tsup-dts-rollup';
+export { shikiBundledThemesInfo } from './_tsup-dts-rollup';
+export { ShikiBundledLanguage } from './_tsup-dts-rollup';
+export { ShikiBundledLanguageInfo } from './_tsup-dts-rollup';
+export { ShikiBundledTheme } from './_tsup-dts-rollup';
+export { ShikiBundledThemeInfo } from './_tsup-dts-rollup';

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

@@ -1,11 +1,11 @@
-import {
-  defineTextBlockEnterRule
-} from "./chunk-6DQPSMHC.js";
 import {
   defineTextBlockInputRule
 } from "./chunk-DYFRBXUX.js";
+import {
+  defineTextBlockEnterRule
+} from "./chunk-ASTUC4KT.js";
 
-// src/code-block/index.ts
+// src/code-block/code-block.ts
 import { union } from "@prosekit/core";
 
 // src/code-block/code-block-commands.ts
@@ -33,17 +33,6 @@ function defineCodeBlockCommands() {
   });
 }
 
-// src/code-block/code-block-highlight.ts
-import { definePlugin } from "@prosekit/core";
-import { createHighlightPlugin } from "prosemirror-highlight";
-function defineCodeBlockHighlight({
-  parser
-}) {
-  return definePlugin(
-    createHighlightPlugin({ parser, nodeTypes: ["codeBlock"] })
-  );
-}
-
 // src/code-block/code-block-input-rule.ts
 function defineCodeBlockInputRule() {
   return defineTextBlockInputRule({
@@ -100,81 +89,6 @@ var existCodeBlock = (state, dispatch) => {
   return false;
 };
 
-// src/code-block/code-block-shikiji.ts
-import { ProseKitError } from "@prosekit/core";
-import { createParser } from "prosemirror-highlight/shikiji";
-async function importGetHighlighter() {
-  try {
-    const { getHighlighter } = await import("shikiji");
-    return getHighlighter;
-  } catch (error) {
-    throw new ProseKitError(
-      "Failed to import package 'shikiji'. Make sure you've installed it.",
-      { cause: error }
-    );
-  }
-}
-async function createHighlighter(theme) {
-  const getHighlighter = await importGetHighlighter();
-  const fallbackLang = "md";
-  return await getHighlighter({
-    langs: [fallbackLang],
-    themes: [theme]
-  });
-}
-function createHighlighterLoader() {
-  let shikijiImport;
-  let highlighter;
-  const loadLangs = /* @__PURE__ */ new Set();
-  const loadThemes = /* @__PURE__ */ new Set();
-  return function highlighterLoader(lang, theme) {
-    if (!shikijiImport) {
-      shikijiImport = createHighlighter(theme).then((result) => {
-        highlighter = result;
-      });
-      return { promise: shikijiImport };
-    }
-    if (!highlighter) {
-      return { promise: shikijiImport };
-    }
-    if (!loadLangs.has(lang)) {
-      const promise = highlighter.loadLanguage(lang).then(() => {
-        loadLangs.add(lang);
-      }).catch(() => {
-      });
-      return { promise };
-    }
-    if (!loadThemes.has(theme)) {
-      const promise = highlighter.loadTheme(theme).then(() => {
-        loadThemes.add(theme);
-      }).catch(() => {
-      });
-      return { promise };
-    }
-    return { highlighter };
-  };
-}
-function createLazyParser(theme) {
-  let parser;
-  const highlighterLoader = createHighlighterLoader();
-  return function lazyParser(options) {
-    const language = options.language || "";
-    const { highlighter, promise } = highlighterLoader(language, theme);
-    if (!highlighter) {
-      return promise || [];
-    }
-    if (!parser) {
-      parser = createParser(highlighter);
-    }
-    return parser(options);
-  };
-}
-function defineCodeBlockShikiji(options) {
-  const theme = (options == null ? void 0 : options.theme) || "one-dark-pro";
-  const parser = createLazyParser(theme);
-  return defineCodeBlockHighlight({ parser });
-}
-
 // src/code-block/code-block-spec.ts
 import { defineNodeSpec } from "@prosekit/core";
 function defineCodeBlockSpec() {
@@ -202,7 +116,7 @@ function defineCodeBlockSpec() {
   });
 }
 
-// src/code-block/index.ts
+// src/code-block/code-block.ts
 function defineCodeBlock() {
   return union([
     defineCodeBlockSpec(),
@@ -212,12 +126,89 @@ function defineCodeBlock() {
     defineCodeBlockCommands()
   ]);
 }
+
+// src/code-block/code-block-highlight.ts
+import { definePlugin } from "@prosekit/core";
+import { createHighlightPlugin } from "prosemirror-highlight";
+function defineCodeBlockHighlight({
+  parser
+}) {
+  return definePlugin(
+    createHighlightPlugin({ parser, nodeTypes: ["codeBlock"] })
+  );
+}
+
+// src/code-block/shiki-parser.ts
+import { createParser } from "prosemirror-highlight/shiki";
+function createHighlighterLoader() {
+  let highlighterPromise;
+  let highlighter;
+  const loadLangs = /* @__PURE__ */ new Set();
+  return function highlighterLoader(lang, options) {
+    if (!highlighterPromise) {
+      highlighterPromise = import("./shiki-import-25BJYIO2.js").then(({ getHighlighter }) => {
+        return getHighlighter(options);
+      }).then((h) => {
+        highlighter = h;
+      });
+      return { promise: highlighterPromise };
+    }
+    if (!highlighter) {
+      return { promise: highlighterPromise };
+    }
+    if (!loadLangs.has(lang)) {
+      const promise = highlighter.loadLanguage(lang).then(() => {
+        loadLangs.add(lang);
+      }).catch((error) => {
+        console.warn(`Failed to load language '${lang}'`, error);
+      });
+      return { promise };
+    }
+    return { highlighter };
+  };
+}
+function createLazyParser(highlighterOptions) {
+  let parser;
+  const highlighterLoader = createHighlighterLoader();
+  return function lazyParser(options) {
+    const language = options.language || "";
+    const { highlighter, promise } = highlighterLoader(
+      language,
+      highlighterOptions
+    );
+    if (!highlighter) {
+      return promise || [];
+    }
+    if (!parser) {
+      parser = createParser(highlighter);
+    }
+    return parser(options);
+  };
+}
+
+// src/code-block/code-block-shiki.ts
+function defineCodeBlockShiki({
+  themes = ["one-dark-pro"],
+  langs = ["text"],
+  langAlias = {}
+} = {}) {
+  const parser = createLazyParser({ themes, langs, langAlias });
+  return defineCodeBlockHighlight({ parser });
+}
+
+// src/code-block/shiki-bundle.ts
+import {
+  bundledLanguagesInfo,
+  bundledThemesInfo
+} from "shiki";
 export {
   defineCodeBlock,
   defineCodeBlockCommands,
   defineCodeBlockEnterRule,
   defineCodeBlockHighlight,
   defineCodeBlockInputRule,
-  defineCodeBlockShikiji,
-  defineCodeBlockSpec
+  defineCodeBlockShiki,
+  defineCodeBlockSpec,
+  bundledLanguagesInfo as shikiBundledLanguagesInfo,
+  bundledThemesInfo as shikiBundledThemesInfo
 };

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

@@ -0,0 +1,5 @@
+export { defineEnterRule } from './_tsup-dts-rollup';
+export { defineTextBlockEnterRule } from './_tsup-dts-rollup';
+export { EnterRuleHandler } from './_tsup-dts-rollup';
+export { EnterRuleOptions } from './_tsup-dts-rollup';
+export { TextBlockEnterRuleOptions } from './_tsup-dts-rollup';

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

@@ -0,0 +1,8 @@
+import {
+  defineEnterRule,
+  defineTextBlockEnterRule
+} from "./chunk-ASTUC4KT.js";
+export {
+  defineEnterRule,
+  defineTextBlockEnterRule
+};

package/dist/prosekit-extensions-link.js

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

package/dist/shiki-import-25BJYIO2.js

@@ -0,0 +1,5 @@
+// src/code-block/shiki-import.ts
+import { getHighlighter } from "shiki/bundle/full";
+export {
+  getHighlighter
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@prosekit/extensions",
   "type": "module",
-  "version": "0.3.2",
+  "version": "0.4.1",
   "private": false,
   "author": {
     "name": "ocavue",
@@ -60,6 +60,11 @@
       "import": "./dist/prosekit-extensions-drop-cursor.js",
       "default": "./dist/prosekit-extensions-drop-cursor.js"
     },
+    "./enter-rule": {
+      "types": "./dist/prosekit-extensions-enter-rule.d.ts",
+      "import": "./dist/prosekit-extensions-enter-rule.js",
+      "default": "./dist/prosekit-extensions-enter-rule.js"
+    },
     "./heading": {
       "types": "./dist/prosekit-extensions-heading.d.ts",
       "import": "./dist/prosekit-extensions-heading.js",
@@ -135,22 +140,14 @@
   ],
   "dependencies": {
     "@prosekit/core": "^0.4.0",
-    "@prosekit/pm": "^0.1.1",
+    "@prosekit/pm": "^0.1.2",
     "prosemirror-dropcursor": "^1.8.1",
     "prosemirror-flat-list": "^0.4.6",
-    "prosemirror-highlight": "^0.5.0"
-  },
-  "peerDependencies": {
-    "shikiji": ">= 0.9.0"
-  },
-  "peerDependenciesMeta": {
-    "shikiji": {
-      "optional": true
-    }
+    "prosemirror-highlight": "^0.5.0",
+    "shiki": "^1.1.2"
   },
   "devDependencies": {
     "@prosekit/dev": "*",
-    "shikiji": "^0.10.2",
     "tsup": "^8.0.2",
     "typescript": "^5.3.3",
     "vitest": "^1.2.2"
@@ -183,6 +180,9 @@
       "drop-cursor": [
         "./dist/prosekit-extensions-drop-cursor.d.ts"
       ],
+      "enter-rule": [
+        "./dist/prosekit-extensions-enter-rule.d.ts"
+      ],
       "heading": [
         "./dist/prosekit-extensions-heading.d.ts"
       ],