@prosekit/extensions 0.1.4 → 0.1.6

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

@@ -8,12 +8,12 @@ import { IndentListOptions } from 'prosemirror-flat-list';
 import { ListAttributes } from 'prosemirror-flat-list';
 import { NodeRange } from 'prosemirror-model';
 import { Options } from 'tsup';
+import { Parser } from 'prosemirror-highlight';
 import { Plugin as Plugin_2 } from '@prosekit/pm/state';
 import { PluginKey } from '@prosekit/pm/state';
 import { ToggleCollapsedOptions } from 'prosemirror-flat-list';
 import { Transaction } from '@prosekit/pm/state';
 import { UnwrapListOptions } from 'prosemirror-flat-list';
-import { UserProjectConfigExport } from 'vitest/dist/config.js';
 
 declare class AutocompleteRule {
     readonly regex: RegExp;
@@ -34,6 +34,11 @@ declare class AutocompleteRule {
 export { AutocompleteRule }
 export { AutocompleteRule as AutocompleteRule_alias_1 }
 
+/**
+ * The attributes for the `codeBlock` node.
+ *
+ * @public
+ */
 declare interface CodeBlockAttrs {
     language?: string;
 }
@@ -48,7 +53,11 @@ export declare function createPredictionPlugin(options: SuggestionOptions): Plug
 
 export declare const default_alias: Options | Options[] | ((overrideOptions: Options) => Options | Options[] | Promise<Options | Options[]>);
 
-export declare const default_alias_1: UserProjectConfigExport;
+export declare const default_alias_1: {
+    test: {
+        environment: "jsdom";
+    };
+};
 
 export declare function defaultCanMatch({ state }: {
     state: EditorState;
@@ -104,10 +113,25 @@ toggleCode: [];
 }>;
 
 /**
+ * Adds `codeBlock` nodes to the editor. This includes the following extensions:
+ *
+ * - {@link defineCodeBlockSpec}
+ * - {@link defineCodeBlockInputRule}
+ * - {@link defineCodeBlockCommands}.
+ *
  * @public
  */
 export declare function defineCodeBlock(options?: {
+    /**
+     * @deprecated Use `defineCodeBlockHighlight` function instead.
+     */
     hljs?: HLJSApi;
+    /**
+     * A parser for the `prosemirror-highlight` package to use for syntax highlighting.
+     *
+     * @deprecated Use the standalone `defineCodeBlockHighlight` function instead.
+     */
+    parser?: HighlightParser;
 }): Extension<    {
 NODES: "codeBlock";
 COMMAND_ARGS: {
@@ -115,21 +139,59 @@ setCodeBlockLanguage: [language: string];
 };
 }>;
 
-export declare function defineCodeBlockCommands(): Extension<    {
+/**
+ * Adds commands for working with `codeBlock` nodes.
+ *
+ * @public
+ */
+declare function defineCodeBlockCommands(): Extension<    {
 COMMAND_ARGS: {
 setCodeBlockLanguage: [language: string];
 };
 }>;
+export { defineCodeBlockCommands }
+export { defineCodeBlockCommands as defineCodeBlockCommands_alias_1 }
+
+/**
+ * Adds syntax highlighting to code blocks. This function requires a `Parser`
+ * instance from the `prosemirror-highlight` package. See the
+ * [documentation](https://github.com/ocavue/prosemirror-highlight) for more
+ * information.
+ *
+ * @public
+ */
+declare function defineCodeBlockHighlight({ parser, }: {
+    parser: HighlightParser;
+}): Extension;
+export { defineCodeBlockHighlight }
+export { defineCodeBlockHighlight as defineCodeBlockHighlight_alias_1 }
 
-export declare function defineCodeBlockHighlight(options: {
+/**
+ * @deprecated
+ */
+export declare function defineCodeBlockHighlightDeprecated(options: {
     hljs?: HLJSApi;
 }): Extension<ExtensionTyping<string, string, CommandArgs>>;
 
-export declare function defineCodeBlockInputRule(): Extension<ExtensionTyping<string, string, CommandArgs>>;
+/**
+ * Adds input rules for `codeBlock` nodes.
+ *
+ * @public
+ */
+declare function defineCodeBlockInputRule(): Extension<ExtensionTyping<string, string, CommandArgs>>;
+export { defineCodeBlockInputRule }
+export { defineCodeBlockInputRule as defineCodeBlockInputRule_alias_1 }
 
-export declare function defineCodeBlockSpec(): Extension<    {
+/**
+ * Defines the `codeBlock` node spec.
+ *
+ * @public
+ */
+declare function defineCodeBlockSpec(): Extension<    {
 NODES: "codeBlock";
 }>;
+export { defineCodeBlockSpec }
+export { defineCodeBlockSpec as defineCodeBlockSpec_alias_1 }
 
 export declare function defineCodeCommands(): Extension<    {
 COMMAND_ARGS: {
@@ -376,6 +438,15 @@ export declare interface HeadingAttrs {
     level: number;
 }
 
+/**
+ * @public
+ *
+ * An alias for the `Parser` type from the `prosemirror-highlight` package.
+ */
+declare type HighlightParser = Parser;
+export { HighlightParser }
+export { HighlightParser as HighlightParser_alias_1 }
+
 export declare interface ImageAttrs {
     src?: string | null;
 }

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

@@ -1,5 +1,7 @@
-export { defineCodeBlockSpec } from './_tsup-dts-rollup';
-export { defineCodeBlockInputRule } from './_tsup-dts-rollup';
-export { defineCodeBlockCommands } from './_tsup-dts-rollup';
 export { defineCodeBlock } from './_tsup-dts-rollup';
+export { defineCodeBlockCommands_alias_1 as defineCodeBlockCommands } from './_tsup-dts-rollup';
+export { defineCodeBlockHighlight_alias_1 as defineCodeBlockHighlight } from './_tsup-dts-rollup';
+export { defineCodeBlockInputRule_alias_1 as defineCodeBlockInputRule } 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';

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

@@ -1,19 +1,41 @@
 // src/code-block/index.ts
-import {
-  defineCommands,
-  defineInputRule,
-  defineNodeSpec,
-  union,
-  getNodeType
-} from "@prosekit/core";
-import { textblockTypeInputRule } from "@prosekit/pm/inputrules";
+import { union } from "@prosekit/core";
+
+// src/code-block/code-block-commands.ts
+import { defineCommands } from "@prosekit/core";
+function defineCodeBlockCommands() {
+  return defineCommands({
+    setCodeBlockLanguage: (language) => (state, dispatch) => {
+      const pos = state.selection.$from.before();
+      const codeBlock = state.doc.nodeAt(pos);
+      if (!codeBlock || codeBlock.type.name !== "codeBlock") {
+        return false;
+      }
+      const { tr } = state;
+      tr.setNodeMarkup(pos, void 0, { language });
+      dispatch == null ? void 0 : dispatch(tr);
+      return true;
+    }
+  });
+}
 
 // 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-highlight-deprecated.ts
+import { definePlugin as definePlugin2 } from "@prosekit/core";
 import { PluginKey, ProseMirrorPlugin } from "@prosekit/pm/state";
 import { DecorationSet } from "@prosekit/pm/view";
 import { getHighlightDecorations } from "prosemirror-highlightjs";
-function defineCodeBlockHighlight(options) {
+function defineCodeBlockHighlightDeprecated(options) {
   const hljs = options.hljs;
   const plugin = new ProseMirrorPlugin({
     key,
@@ -41,7 +63,7 @@ function defineCodeBlockHighlight(options) {
       }
     }
   });
-  return definePlugin(plugin);
+  return definePlugin2(plugin);
 }
 var key = new PluginKey("prosekit-code-block-highlight");
 var blockTypes = ["codeBlock"];
@@ -49,7 +71,21 @@ function languageExtractor(node) {
   return node.attrs.language || "javascript";
 }
 
-// src/code-block/index.ts
+// src/code-block/code-block-input-rule.ts
+import { defineInputRule, getNodeType } from "@prosekit/core";
+import { textblockTypeInputRule } from "@prosekit/pm/inputrules";
+function defineCodeBlockInputRule() {
+  return defineInputRule(({ schema }) => {
+    const nodeType = getNodeType(schema, "codeBlock");
+    const getAttrs = (match) => {
+      return { language: match[1] || "" };
+    };
+    return textblockTypeInputRule(/^```(\S*)\s$/, nodeType, getAttrs);
+  });
+}
+
+// src/code-block/code-block-spec.ts
+import { defineNodeSpec } from "@prosekit/core";
 function defineCodeBlockSpec() {
   return defineNodeSpec({
     name: "codeBlock",
@@ -72,47 +108,35 @@ function defineCodeBlockSpec() {
       const attrs = node.attrs;
       return [
         "pre",
+        // TODO: remove class 'hljs'
         { "data-language": attrs.language, class: "hljs" },
         ["code", 0]
       ];
     }
   });
 }
-function defineCodeBlockInputRule() {
-  return defineInputRule(({ schema }) => {
-    const nodeType = getNodeType(schema, "codeBlock");
-    const getAttrs = (match) => {
-      return { language: match[1] || "" };
-    };
-    return textblockTypeInputRule(/^```(\S*)\s$/, nodeType, getAttrs);
-  });
-}
-function defineCodeBlockCommands() {
-  return defineCommands({
-    setCodeBlockLanguage: (language) => (state, dispatch) => {
-      const pos = state.selection.$from.before();
-      const codeBlock = state.doc.nodeAt(pos);
-      if (!codeBlock || codeBlock.type.name !== "codeBlock") {
-        return false;
-      }
-      const { tr } = state;
-      tr.setNodeMarkup(pos, void 0, { language });
-      dispatch == null ? void 0 : dispatch(tr);
-      return true;
-    }
-  });
-}
+
+// src/code-block/index.ts
 function defineCodeBlock(options) {
-  return union([
+  const extensions = [
     defineCodeBlockSpec(),
     defineCodeBlockInputRule(),
-    defineCodeBlockHighlight({ hljs: options == null ? void 0 : options.hljs }),
     defineCodeBlockCommands()
-  ]);
+  ];
+  const parser = options == null ? void 0 : options.parser;
+  if (parser) {
+    extensions.push(defineCodeBlockHighlight({ parser }));
+  }
+  const hljs = options == null ? void 0 : options.hljs;
+  if (hljs) {
+    extensions.push(defineCodeBlockHighlightDeprecated({ hljs }));
+  }
+  return union(extensions);
 }
 export {
   defineCodeBlock,
   defineCodeBlockCommands,
+  defineCodeBlockHighlight,
   defineCodeBlockInputRule,
   defineCodeBlockSpec
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@prosekit/extensions",
   "type": "module",
-  "version": "0.1.4",
+  "version": "0.1.6",
   "private": false,
   "author": {
     "name": "ocavue",
@@ -121,17 +121,18 @@
     "dist"
   ],
   "dependencies": {
-    "@prosekit/core": "^0.1.0",
-    "@prosekit/pm": "^0.1.0",
+    "@prosekit/core": "^0.1.8",
+    "@prosekit/pm": "^0.1.1",
     "highlight.js": "^11.9.0",
     "prosemirror-flat-list": "^0.4.5",
+    "prosemirror-highlight": "^0.3.2",
     "prosemirror-highlightjs": "^0.9.1"
   },
   "devDependencies": {
     "@prosekit/dev": "*",
     "tsup": "^8.0.1",
-    "typescript": "^5.3.2",
-    "vitest": "^0.34.6"
+    "typescript": "^5.3.3",
+    "vitest": "^1.0.4"
   },
   "scripts": {
     "build:tsup": "tsup",