@shikijs/twoslash 1.0.0 → 1.1.1

package/dist/core.d.mts

@@ -1,4 +1,4 @@
-import { TwoslashReturn, TwoslashExecuteOptions, TwoslashOptions, NodeError, NodeTag, NodeQuery, NodeCompletion, NodeHover, NodeHighlight } from 'twoslash';
+import { TwoslashReturn, TwoslashExecuteOptions, TwoslashGenericFunction, TwoslashOptions, NodeError, NodeTag, NodeQuery, NodeCompletion, NodeHover, NodeHighlight } from 'twoslash';
 import { CodeToHastOptions, ShikiTransformerContext, ShikiTransformerContextCommon, ShikiTransformer } from '@shikijs/core';
 import { ElementContent, Element, Text } from 'hast';
 
@@ -34,7 +34,7 @@ interface TransformerTwoslashOptions {
     /**
      * Custom instance of twoslasher function
      */
-    twoslasher?: TwoslashShikiFunction;
+    twoslasher?: TwoslashShikiFunction | TwoslashGenericFunction;
     /**
      * Options to pass to twoslash
      */
@@ -48,6 +48,17 @@ interface TransformerTwoslashOptions {
      * @default true
      */
     throws?: boolean;
+    /**
+     * Custom error handler for twoslash errors
+     * When specified, `throws` will be ignored
+     * Optionally return a string to replace the code
+     */
+    onTwoslashError?: (error: unknown, code: string, lang: string, options: CodeToHastOptions) => string | void;
+    /**
+     * Custom error handler for Shiki errors
+     * When specified, `throws` will be ignored
+     */
+    onShikiError?: (error: unknown) => void;
 }
 interface TwoslashRenderer {
     lineError?: (this: ShikiTransformerContext, error: NodeError) => ElementContent[];
@@ -62,10 +73,6 @@ interface TwoslashRenderer {
     nodesHighlight?: (this: ShikiTransformerContext, highlight: NodeHighlight, nodes: ElementContent[]) => ElementContent[];
 }
 
-type CompletionItem = NonNullable<NodeCompletion['completions']>[number];
-declare const defaultCompletionIcons: Record<CompletionItem['kind'], Element | undefined>;
-declare const defaultCustomTagIcons: Record<string, Element | undefined>;
-
 interface RendererRichOptions {
     /**
      * Render JSDoc comments in hover popup.
@@ -80,7 +87,7 @@ interface RendererRichOptions {
      * If `false`, no icons will be rendered.
      * @default defaultCompletionIcons
      */
-    completionIcons?: Partial<Record<CompletionItem['kind'], ElementContent>> | false;
+    completionIcons?: Partial<Record<string, ElementContent>> | false;
     /**
      * Custom icons for custom tags lines.
      * A map from tag name to a HAST node.
@@ -245,6 +252,10 @@ declare function defaultHoverInfoProcessor(type: string): string;
  */
 declare function rendererClassic(): TwoslashRenderer;
 
+type CompletionItem = NonNullable<NodeCompletion['completions']>[number];
+declare const defaultCompletionIcons: Record<string, Element | undefined>;
+declare const defaultCustomTagIcons: Record<string, Element | undefined>;
+
 declare class ShikiTwoslashError extends Error {
     constructor(message: string);
 }
@@ -255,6 +266,6 @@ declare class ShikiTwoslashError extends Error {
  */
 
 declare function defaultTwoslashOptions(): TwoslashExecuteOptions;
-declare function createTransformerFactory(defaultTwoslasher: TwoslashShikiFunction, defaultRenderer?: TwoslashRenderer): (options?: TransformerTwoslashOptions) => ShikiTransformer;
+declare function createTransformerFactory(defaultTwoslasher: TwoslashShikiFunction | TwoslashGenericFunction, defaultRenderer?: TwoslashRenderer): (options?: TransformerTwoslashOptions) => ShikiTransformer;
 
 export { type CompletionItem, type HastExtension, type RendererRichOptions, ShikiTwoslashError, type TransformerTwoslashOptions, type TwoslashRenderer, type TwoslashShikiFunction, type TwoslashShikiReturn, createTransformerFactory, defaultCompletionIcons, defaultCustomTagIcons, defaultHoverInfoProcessor, defaultTwoslashOptions, rendererClassic, rendererRich };

package/dist/core.d.ts

@@ -1,4 +1,4 @@
-import { TwoslashReturn, TwoslashExecuteOptions, TwoslashOptions, NodeError, NodeTag, NodeQuery, NodeCompletion, NodeHover, NodeHighlight } from 'twoslash';
+import { TwoslashReturn, TwoslashExecuteOptions, TwoslashGenericFunction, TwoslashOptions, NodeError, NodeTag, NodeQuery, NodeCompletion, NodeHover, NodeHighlight } from 'twoslash';
 import { CodeToHastOptions, ShikiTransformerContext, ShikiTransformerContextCommon, ShikiTransformer } from '@shikijs/core';
 import { ElementContent, Element, Text } from 'hast';
 
@@ -34,7 +34,7 @@ interface TransformerTwoslashOptions {
     /**
      * Custom instance of twoslasher function
      */
-    twoslasher?: TwoslashShikiFunction;
+    twoslasher?: TwoslashShikiFunction | TwoslashGenericFunction;
     /**
      * Options to pass to twoslash
      */
@@ -48,6 +48,17 @@ interface TransformerTwoslashOptions {
      * @default true
      */
     throws?: boolean;
+    /**
+     * Custom error handler for twoslash errors
+     * When specified, `throws` will be ignored
+     * Optionally return a string to replace the code
+     */
+    onTwoslashError?: (error: unknown, code: string, lang: string, options: CodeToHastOptions) => string | void;
+    /**
+     * Custom error handler for Shiki errors
+     * When specified, `throws` will be ignored
+     */
+    onShikiError?: (error: unknown) => void;
 }
 interface TwoslashRenderer {
     lineError?: (this: ShikiTransformerContext, error: NodeError) => ElementContent[];
@@ -62,10 +73,6 @@ interface TwoslashRenderer {
     nodesHighlight?: (this: ShikiTransformerContext, highlight: NodeHighlight, nodes: ElementContent[]) => ElementContent[];
 }
 
-type CompletionItem = NonNullable<NodeCompletion['completions']>[number];
-declare const defaultCompletionIcons: Record<CompletionItem['kind'], Element | undefined>;
-declare const defaultCustomTagIcons: Record<string, Element | undefined>;
-
 interface RendererRichOptions {
     /**
      * Render JSDoc comments in hover popup.
@@ -80,7 +87,7 @@ interface RendererRichOptions {
      * If `false`, no icons will be rendered.
      * @default defaultCompletionIcons
      */
-    completionIcons?: Partial<Record<CompletionItem['kind'], ElementContent>> | false;
+    completionIcons?: Partial<Record<string, ElementContent>> | false;
     /**
      * Custom icons for custom tags lines.
      * A map from tag name to a HAST node.
@@ -245,6 +252,10 @@ declare function defaultHoverInfoProcessor(type: string): string;
  */
 declare function rendererClassic(): TwoslashRenderer;
 
+type CompletionItem = NonNullable<NodeCompletion['completions']>[number];
+declare const defaultCompletionIcons: Record<string, Element | undefined>;
+declare const defaultCustomTagIcons: Record<string, Element | undefined>;
+
 declare class ShikiTwoslashError extends Error {
     constructor(message: string);
 }
@@ -255,6 +266,6 @@ declare class ShikiTwoslashError extends Error {
  */
 
 declare function defaultTwoslashOptions(): TwoslashExecuteOptions;
-declare function createTransformerFactory(defaultTwoslasher: TwoslashShikiFunction, defaultRenderer?: TwoslashRenderer): (options?: TransformerTwoslashOptions) => ShikiTransformer;
+declare function createTransformerFactory(defaultTwoslasher: TwoslashShikiFunction | TwoslashGenericFunction, defaultRenderer?: TwoslashRenderer): (options?: TransformerTwoslashOptions) => ShikiTransformer;
 
 export { type CompletionItem, type HastExtension, type RendererRichOptions, ShikiTwoslashError, type TransformerTwoslashOptions, type TwoslashRenderer, type TwoslashShikiFunction, type TwoslashShikiReturn, createTransformerFactory, defaultCompletionIcons, defaultCustomTagIcons, defaultHoverInfoProcessor, defaultTwoslashOptions, rendererClassic, rendererRich };

package/dist/core.mjs

@@ -557,52 +557,56 @@ function rendererRich(options = {}) {
     nodeCompletion(query, node) {
       if (node.type !== "text")
         throw new ShikiTwoslashError(`Renderer hook nodeCompletion only works on text nodes, got ${node.type}`);
-      const items = query.completions.map((i) => ({
-        type: "element",
-        tagName: "li",
-        properties: {},
-        children: [
-          ...completionIcons ? [{
-            type: "element",
-            tagName: "span",
-            properties: { class: `twoslash-completions-icon completions-${i.kind.replace(/\s/g, "-")}` },
-            children: [
-              completionIcons[i.kind] || completionIcons.property
-            ].filter(Boolean)
-          }] : [],
-          {
-            type: "element",
-            tagName: "span",
-            properties: {
-              class: i.kindModifiers?.split(",").includes("deprecated") ? "deprecated" : void 0
-            },
-            children: [
-              {
-                type: "element",
-                tagName: "span",
-                properties: { class: "twoslash-completions-matched" },
-                children: [
-                  {
-                    type: "text",
-                    value: i.name.startsWith(query.completionsPrefix) ? query.completionsPrefix : ""
-                  }
-                ]
+      const items = query.completions.map((i) => {
+        const kind = i.kind || "default";
+        const isDeprecated = "kindModifiers" in i && typeof i.kindModifiers === "string" && i.kindModifiers?.split(",").includes("deprecated");
+        return {
+          type: "element",
+          tagName: "li",
+          properties: {},
+          children: [
+            ...completionIcons ? [{
+              type: "element",
+              tagName: "span",
+              properties: { class: `twoslash-completions-icon completions-${kind.replace(/\s/g, "-")}` },
+              children: [
+                completionIcons[kind] || completionIcons.property
+              ].filter(Boolean)
+            }] : [],
+            {
+              type: "element",
+              tagName: "span",
+              properties: {
+                class: isDeprecated ? "deprecated" : void 0
               },
-              {
-                type: "element",
-                tagName: "span",
-                properties: { class: "twoslash-completions-unmatched" },
-                children: [
-                  {
-                    type: "text",
-                    value: i.name.startsWith(query.completionsPrefix) ? i.name.slice(query.completionsPrefix.length || 0) : i.name
-                  }
-                ]
-              }
-            ]
-          }
-        ]
-      }));
+              children: [
+                {
+                  type: "element",
+                  tagName: "span",
+                  properties: { class: "twoslash-completions-matched" },
+                  children: [
+                    {
+                      type: "text",
+                      value: i.name.startsWith(query.completionsPrefix) ? query.completionsPrefix : ""
+                    }
+                  ]
+                },
+                {
+                  type: "element",
+                  tagName: "span",
+                  properties: { class: "twoslash-completions-unmatched" },
+                  children: [
+                    {
+                      type: "text",
+                      value: i.name.startsWith(query.completionsPrefix) ? i.name.slice(query.completionsPrefix.length || 0) : i.name
+                    }
+                  ]
+                }
+              ]
+            }
+          ]
+        };
+      });
       const cursor = extend(
         hast?.completionCursor,
         {
@@ -778,14 +782,14 @@ function defaultHoverInfoProcessor(type) {
 }
 function getErrorLevelClass(error) {
   switch (error.level) {
-    case 0:
+    case "warning":
       return "twoslash-error-level-warning";
-    case 1:
-      return "";
-    case 2:
+    case "suggestion":
       return "twoslash-error-level-suggestion";
+    case "message":
+      return "twoslash-error-level-message";
     default:
-      return "twoslash-error-level-info";
+      return "";
   }
 }
 
@@ -879,7 +883,7 @@ function rendererClassic() {
                   type: "element",
                   tagName: "li",
                   properties: {
-                    class: i.kindModifiers?.split(",").includes("deprecated") ? "deprecated" : void 0
+                    class: "kindModifiers" in i && typeof i.kindModifiers === "string" && i.kindModifiers?.split(",").includes("deprecated") ? "deprecated" : void 0
                   },
                   children: [{
                     type: "element",
@@ -986,9 +990,16 @@ function createTransformerFactory(defaultTwoslasher, defaultRenderer) {
       renderer = defaultRenderer,
       throws = true
     } = options;
+    const onTwoslashError = options.onTwoslashError || (throws ? (error) => {
+      throw error;
+    } : () => false);
+    const onShikiError = options.onShikiError || (throws ? (error) => {
+      throw error;
+    } : () => false);
     const trigger = explicitTrigger instanceof RegExp ? explicitTrigger : /\btwoslash\b/;
     if (!renderer)
       throw new ShikiTwoslashError("Missing renderer");
+    const map = /* @__PURE__ */ new WeakMap();
     const filter = options.filter || ((lang, _, options2) => langs.includes(lang) && (!explicitTrigger || trigger.test(options2.meta?.__raw || "")));
     return {
       preprocess(code) {
@@ -996,28 +1007,38 @@ function createTransformerFactory(defaultTwoslasher, defaultRenderer) {
         if (lang in langAlias)
           lang = langAlias[this.options.lang];
         if (filter(lang, code, this.options)) {
-          const twoslash = twoslasher(code, lang, twoslashOptions);
-          this.meta.twoslash = twoslash;
-          this.options.lang = twoslash.meta?.extension || lang;
-          return twoslash.code;
+          try {
+            const twoslash = twoslasher(code, lang, twoslashOptions);
+            map.set(this.meta, twoslash);
+            this.meta.twoslash = twoslash;
+            this.options.lang = twoslash.meta?.extension || lang;
+            return twoslash.code;
+          } catch (error) {
+            const result = onTwoslashError(error, code, lang, this.options);
+            if (typeof result === "string")
+              return code;
+          }
         }
       },
       tokens(tokens) {
-        if (!this.meta.twoslash)
+        const twoslash = map.get(this.meta);
+        if (!twoslash)
           return;
         return splitTokens(
           tokens,
-          this.meta.twoslash.nodes.flatMap(
+          twoslash.nodes.flatMap(
             (i) => ["hover", "error", "query", "highlight", "completion"].includes(i.type) ? [i.start, i.start + i.length] : []
           )
         );
       },
       pre(pre) {
-        if (this.meta.twoslash)
-          this.addClassToHast(pre, "twoslash lsp");
+        const twoslash = map.get(this.meta);
+        if (!twoslash)
+          return;
+        this.addClassToHast(pre, "twoslash lsp");
       },
       code(codeEl) {
-        const twoslash = this.meta.twoslash;
+        const twoslash = map.get(this.meta);
         if (!twoslash)
           return;
         const insertAfterLine = (line, nodes) => {
@@ -1030,8 +1051,7 @@ function createTransformerFactory(defaultTwoslasher, defaultRenderer) {
             const lineEl = this.lines[line];
             index = codeEl.children.indexOf(lineEl);
             if (index === -1) {
-              if (throws)
-                throw new ShikiTwoslashError(`Cannot find line ${line} in code element`);
+              onShikiError(new ShikiTwoslashError(`Cannot find line ${line} in code element`));
               return;
             }
           }
@@ -1068,6 +1088,10 @@ function createTransformerFactory(defaultTwoslasher, defaultRenderer) {
             continue;
           }
           const tokens = locateTextTokens(node.line, node.character, node.length);
+          if (!tokens.length && !(node.type === "error" && renderer.nodesError)) {
+            onShikiError(new ShikiTwoslashError(`Cannot find tokens for node: ${JSON.stringify(node)}`));
+            continue;
+          }
           const wrapTokens = (fn) => {
             const line = this.lines[node.line];
             let charIndex = 0;
@@ -1153,8 +1177,7 @@ function createTransformerFactory(defaultTwoslasher, defaultRenderer) {
               break;
             }
             default: {
-              if (throws)
-                throw new ShikiTwoslashError(`Unknown node type: ${node.type}`);
+              onShikiError(new ShikiTwoslashError(`Unknown node type: ${node?.type}`));
             }
           }
         }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@shikijs/twoslash",
   "type": "module",
-  "version": "1.0.0",
+  "version": "1.1.1",
   "description": "Shiki transformer for twoslash",
   "author": "Anthony Fu <anthonyfu117@hotmail.com>",
   "license": "MIT",
@@ -49,11 +49,11 @@
     "dist"
   ],
   "dependencies": {
-    "twoslash": "^0.1.2",
-    "@shikijs/core": "1.0.0"
+    "twoslash": "^0.2.1",
+    "@shikijs/core": "1.1.1"
   },
   "devDependencies": {
-    "@iconify-json/carbon": "^1.1.28",
+    "@iconify-json/carbon": "^1.1.29",
     "@iconify-json/codicon": "^1.1.41",
     "@shikijs/twoslash": "^3.1.2",
     "hast-util-from-html": "^2.0.1",