@shikijs/twoslash 1.16.2 → 1.17.0

package/dist/core.d.mts

@@ -1,5 +1,5 @@
+import { CodeToHastOptions, ShikiTransformerContext, ShikiTransformerContextCommon, ShikiTransformer } from '@shikijs/types';
 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';
 
 type TwoslashShikiReturn = Pick<TwoslashReturn, 'nodes' | 'code'> & {
@@ -78,6 +78,19 @@ interface TwoslashRenderer {
     nodesHighlight?: (this: ShikiTransformerContext, highlight: NodeHighlight, nodes: ElementContent[]) => ElementContent[];
 }
 
+declare class ShikiTwoslashError extends Error {
+    constructor(message: string);
+}
+
+type CompletionItem = NonNullable<NodeCompletion['completions']>[number];
+declare const defaultCompletionIcons: Record<string, Element | undefined>;
+declare const defaultCustomTagIcons: Record<string, Element | undefined>;
+
+/**
+ * The default renderer aligning with the original `@shikijs/twoslash` output.
+ */
+declare function rendererClassic(): TwoslashRenderer;
+
 interface RendererRichOptions {
     /**
      * Render JSDoc comments in hover popup.
@@ -259,24 +272,6 @@ declare function rendererRich(options?: RendererRichOptions): TwoslashRenderer;
  */
 declare function defaultHoverInfoProcessor(type: string): string;
 
-/**
- * The default renderer aligning with the original `@shikijs/twoslash` output.
- */
-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);
-}
-
-/**
- * This file is the core of the @shikijs/twoslash package,
- * Decoupled from twoslash's implementation and allowing to introduce custom implementation or cache system.
- */
-
 declare function defaultTwoslashOptions(): TwoslashExecuteOptions;
 declare function createTransformerFactory(defaultTwoslasher: TwoslashShikiFunction | TwoslashGenericFunction, defaultRenderer?: TwoslashRenderer): (options?: TransformerTwoslashOptions) => ShikiTransformer;
 

package/dist/core.d.ts

@@ -1,5 +1,5 @@
+import { CodeToHastOptions, ShikiTransformerContext, ShikiTransformerContextCommon, ShikiTransformer } from '@shikijs/types';
 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';
 
 type TwoslashShikiReturn = Pick<TwoslashReturn, 'nodes' | 'code'> & {
@@ -78,6 +78,19 @@ interface TwoslashRenderer {
     nodesHighlight?: (this: ShikiTransformerContext, highlight: NodeHighlight, nodes: ElementContent[]) => ElementContent[];
 }
 
+declare class ShikiTwoslashError extends Error {
+    constructor(message: string);
+}
+
+type CompletionItem = NonNullable<NodeCompletion['completions']>[number];
+declare const defaultCompletionIcons: Record<string, Element | undefined>;
+declare const defaultCustomTagIcons: Record<string, Element | undefined>;
+
+/**
+ * The default renderer aligning with the original `@shikijs/twoslash` output.
+ */
+declare function rendererClassic(): TwoslashRenderer;
+
 interface RendererRichOptions {
     /**
      * Render JSDoc comments in hover popup.
@@ -259,24 +272,6 @@ declare function rendererRich(options?: RendererRichOptions): TwoslashRenderer;
  */
 declare function defaultHoverInfoProcessor(type: string): string;
 
-/**
- * The default renderer aligning with the original `@shikijs/twoslash` output.
- */
-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);
-}
-
-/**
- * This file is the core of the @shikijs/twoslash package,
- * Decoupled from twoslash's implementation and allowing to introduce custom implementation or cache system.
- */
-
 declare function defaultTwoslashOptions(): TwoslashExecuteOptions;
 declare function createTransformerFactory(defaultTwoslasher: TwoslashShikiFunction | TwoslashGenericFunction, defaultRenderer?: TwoslashRenderer): (options?: TransformerTwoslashOptions) => ShikiTransformer;
 

package/dist/core.mjs

@@ -419,6 +419,183 @@ const tagIcons = {
 const defaultCompletionIcons = completionIcons;
 const defaultCustomTagIcons = tagIcons;
 
+function rendererClassic() {
+  return {
+    nodeStaticInfo(info, node) {
+      return {
+        type: "element",
+        tagName: "data-lsp",
+        properties: {
+          lsp: info.text
+        },
+        children: [node]
+      };
+    },
+    nodeError(_, node) {
+      return {
+        type: "element",
+        tagName: "data-err",
+        properties: {},
+        children: [node]
+      };
+    },
+    lineError(error) {
+      return [
+        {
+          type: "element",
+          tagName: "div",
+          properties: {
+            class: "error"
+          },
+          children: [
+            {
+              type: "element",
+              tagName: "span",
+              properties: {},
+              children: [
+                {
+                  type: "text",
+                  value: error.text
+                }
+              ]
+            },
+            {
+              type: "element",
+              tagName: "span",
+              properties: {
+                class: "code"
+              },
+              children: [
+                {
+                  type: "text",
+                  value: String(error.code)
+                }
+              ]
+            }
+          ]
+        },
+        {
+          type: "element",
+          tagName: "span",
+          properties: {
+            class: "error-behind"
+          },
+          children: [
+            {
+              type: "text",
+              value: error.text
+            }
+          ]
+        }
+      ];
+    },
+    lineCompletion(query) {
+      return [
+        {
+          type: "element",
+          tagName: "div",
+          properties: { class: "meta-line" },
+          children: [
+            { type: "text", value: " ".repeat(query.character) },
+            {
+              type: "element",
+              tagName: "span",
+              properties: { class: "inline-completions" },
+              children: [{
+                type: "element",
+                tagName: "ul",
+                properties: { class: "dropdown" },
+                children: query.completions.filter((i) => i.name.startsWith(query.completionsPrefix || "____")).map((i) => ({
+                  type: "element",
+                  tagName: "li",
+                  properties: {
+                    class: "kindModifiers" in i && typeof i.kindModifiers === "string" && i.kindModifiers?.split(",").includes("deprecated") ? "deprecated" : void 0
+                  },
+                  children: [{
+                    type: "element",
+                    tagName: "span",
+                    properties: {},
+                    children: [
+                      {
+                        type: "element",
+                        tagName: "span",
+                        properties: { class: "result-found" },
+                        children: [
+                          {
+                            type: "text",
+                            value: query.completionsPrefix || ""
+                          }
+                        ]
+                      },
+                      {
+                        type: "text",
+                        value: i.name.slice(query.completionsPrefix?.length || 0)
+                      }
+                    ]
+                  }]
+                }))
+              }]
+            }
+          ]
+        }
+      ];
+    },
+    lineQuery(query, targetNode) {
+      const targetText = targetNode?.type === "text" ? targetNode.value : "";
+      const offset = Math.max(0, (query.character || 0) + Math.floor(targetText.length / 2) - 1);
+      return [
+        {
+          type: "element",
+          tagName: "div",
+          properties: { class: "meta-line" },
+          children: [
+            { type: "text", value: " ".repeat(offset) },
+            {
+              type: "element",
+              tagName: "span",
+              properties: { class: "popover" },
+              children: [
+                {
+                  type: "element",
+                  tagName: "div",
+                  properties: { class: "arrow" },
+                  children: []
+                },
+                {
+                  type: "text",
+                  value: query.text || ""
+                }
+              ]
+            }
+          ]
+        }
+      ];
+    },
+    lineCustomTag(tag) {
+      return [
+        {
+          type: "element",
+          tagName: "div",
+          properties: { class: `meta-line logger ${tag.name}-log` },
+          children: [
+            {
+              type: "element",
+              tagName: "span",
+              properties: { class: "message" },
+              children: [
+                {
+                  type: "text",
+                  value: tag.text || ""
+                }
+              ]
+            }
+          ]
+        }
+      ];
+    }
+  };
+}
+
 function extend(extension, node) {
   if (!extension)
     return node;
@@ -898,183 +1075,6 @@ function getErrorLevelClass(error) {
   }
 }
 
-function rendererClassic() {
-  return {
-    nodeStaticInfo(info, node) {
-      return {
-        type: "element",
-        tagName: "data-lsp",
-        properties: {
-          lsp: info.text
-        },
-        children: [node]
-      };
-    },
-    nodeError(_, node) {
-      return {
-        type: "element",
-        tagName: "data-err",
-        properties: {},
-        children: [node]
-      };
-    },
-    lineError(error) {
-      return [
-        {
-          type: "element",
-          tagName: "div",
-          properties: {
-            class: "error"
-          },
-          children: [
-            {
-              type: "element",
-              tagName: "span",
-              properties: {},
-              children: [
-                {
-                  type: "text",
-                  value: error.text
-                }
-              ]
-            },
-            {
-              type: "element",
-              tagName: "span",
-              properties: {
-                class: "code"
-              },
-              children: [
-                {
-                  type: "text",
-                  value: String(error.code)
-                }
-              ]
-            }
-          ]
-        },
-        {
-          type: "element",
-          tagName: "span",
-          properties: {
-            class: "error-behind"
-          },
-          children: [
-            {
-              type: "text",
-              value: error.text
-            }
-          ]
-        }
-      ];
-    },
-    lineCompletion(query) {
-      return [
-        {
-          type: "element",
-          tagName: "div",
-          properties: { class: "meta-line" },
-          children: [
-            { type: "text", value: " ".repeat(query.character) },
-            {
-              type: "element",
-              tagName: "span",
-              properties: { class: "inline-completions" },
-              children: [{
-                type: "element",
-                tagName: "ul",
-                properties: { class: "dropdown" },
-                children: query.completions.filter((i) => i.name.startsWith(query.completionsPrefix || "____")).map((i) => ({
-                  type: "element",
-                  tagName: "li",
-                  properties: {
-                    class: "kindModifiers" in i && typeof i.kindModifiers === "string" && i.kindModifiers?.split(",").includes("deprecated") ? "deprecated" : void 0
-                  },
-                  children: [{
-                    type: "element",
-                    tagName: "span",
-                    properties: {},
-                    children: [
-                      {
-                        type: "element",
-                        tagName: "span",
-                        properties: { class: "result-found" },
-                        children: [
-                          {
-                            type: "text",
-                            value: query.completionsPrefix || ""
-                          }
-                        ]
-                      },
-                      {
-                        type: "text",
-                        value: i.name.slice(query.completionsPrefix?.length || 0)
-                      }
-                    ]
-                  }]
-                }))
-              }]
-            }
-          ]
-        }
-      ];
-    },
-    lineQuery(query, targetNode) {
-      const targetText = targetNode?.type === "text" ? targetNode.value : "";
-      const offset = Math.max(0, (query.character || 0) + Math.floor(targetText.length / 2) - 1);
-      return [
-        {
-          type: "element",
-          tagName: "div",
-          properties: { class: "meta-line" },
-          children: [
-            { type: "text", value: " ".repeat(offset) },
-            {
-              type: "element",
-              tagName: "span",
-              properties: { class: "popover" },
-              children: [
-                {
-                  type: "element",
-                  tagName: "div",
-                  properties: { class: "arrow" },
-                  children: []
-                },
-                {
-                  type: "text",
-                  value: query.text || ""
-                }
-              ]
-            }
-          ]
-        }
-      ];
-    },
-    lineCustomTag(tag) {
-      return [
-        {
-          type: "element",
-          tagName: "div",
-          properties: { class: `meta-line logger ${tag.name}-log` },
-          children: [
-            {
-              type: "element",
-              tagName: "span",
-              properties: { class: "message" },
-              children: [
-                {
-                  type: "text",
-                  value: tag.text || ""
-                }
-              ]
-            }
-          ]
-        }
-      ];
-    }
-  };
-}
-
 function defaultTwoslashOptions() {
   return {
     customTags: ["annotate", "log", "warn", "error"]

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import * as _shikijs_core from '@shikijs/core';
+import * as _shikijs_types from '@shikijs/types';
 import { CreateTwoslashOptions } from 'twoslash';
 import { TransformerTwoslashOptions, RendererRichOptions } from './core.mjs';
 export { CompletionItem, HastExtension, ShikiTwoslashError, TwoslashRenderer, TwoslashShikiFunction, TwoslashShikiReturn, createTransformerFactory, defaultCompletionIcons, defaultCustomTagIcons, defaultHoverInfoProcessor, defaultTwoslashOptions, rendererClassic, rendererRich } from './core.mjs';
@@ -15,6 +15,6 @@ interface TransformerTwoslashIndexOptions extends TransformerTwoslashOptions, Pi
 /**
  * Factory function to create a Shiki transformer for twoslash integrations.
  */
-declare function transformerTwoslash(options?: TransformerTwoslashIndexOptions): _shikijs_core.ShikiTransformer;
+declare function transformerTwoslash(options?: TransformerTwoslashIndexOptions): _shikijs_types.ShikiTransformer;
 
 export { RendererRichOptions, type TransformerTwoslashIndexOptions, TransformerTwoslashOptions, transformerTwoslash };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import * as _shikijs_core from '@shikijs/core';
+import * as _shikijs_types from '@shikijs/types';
 import { CreateTwoslashOptions } from 'twoslash';
 import { TransformerTwoslashOptions, RendererRichOptions } from './core.js';
 export { CompletionItem, HastExtension, ShikiTwoslashError, TwoslashRenderer, TwoslashShikiFunction, TwoslashShikiReturn, createTransformerFactory, defaultCompletionIcons, defaultCustomTagIcons, defaultHoverInfoProcessor, defaultTwoslashOptions, rendererClassic, rendererRich } from './core.js';
@@ -15,6 +15,6 @@ interface TransformerTwoslashIndexOptions extends TransformerTwoslashOptions, Pi
 /**
  * Factory function to create a Shiki transformer for twoslash integrations.
  */
-declare function transformerTwoslash(options?: TransformerTwoslashIndexOptions): _shikijs_core.ShikiTransformer;
+declare function transformerTwoslash(options?: TransformerTwoslashIndexOptions): _shikijs_types.ShikiTransformer;
 
 export { RendererRichOptions, type TransformerTwoslashIndexOptions, TransformerTwoslashOptions, transformerTwoslash };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@shikijs/twoslash",
   "type": "module",
-  "version": "1.16.2",
+  "version": "1.17.0",
   "description": "Shiki transformer for twoslash",
   "author": "Anthony Fu <anthonyfu117@hotmail.com>",
   "license": "MIT",
@@ -49,15 +49,16 @@
     "dist"
   ],
   "dependencies": {
-    "twoslash": "^0.2.10",
-    "@shikijs/core": "1.16.2"
+    "twoslash": "^0.2.11",
+    "@shikijs/core": "1.17.0",
+    "@shikijs/types": "1.17.0"
   },
   "devDependencies": {
     "@iconify-json/carbon": "^1.2.1",
     "@iconify-json/codicon": "^1.2.0",
     "hast-util-from-html": "^2.0.2",
-    "typescript": "^5.5.4",
-    "@shikijs/twoslash": "1.16.2"
+    "typescript": "^5.6.2",
+    "@shikijs/twoslash": "1.17.0"
   },
   "scripts": {
     "build": "unbuild",