@shikijs/vitepress-twoslash 1.22.2 → 1.23.0

package/dist/cache-fs.d.mts

@@ -0,0 +1,17 @@
+import { b as TwoslashTypesCache } from './shared/vitepress-twoslash.dfe2cbbb.mjs';
+import '@shikijs/twoslash/core';
+import 'twoslash';
+import 'twoslash-vue';
+import '@shikijs/twoslash';
+
+interface FileSystemTypeResultCacheOptions {
+    /**
+     * The directory to store the cache files.
+     *
+     * @default '.vitepress/cache/twoslash'
+     */
+    dir?: string;
+}
+declare function createFileSystemTypesCache(options?: FileSystemTypeResultCacheOptions): TwoslashTypesCache;
+
+export { type FileSystemTypeResultCacheOptions, createFileSystemTypesCache };

package/dist/cache-fs.d.ts

@@ -0,0 +1,17 @@
+import { b as TwoslashTypesCache } from './shared/vitepress-twoslash.dfe2cbbb.js';
+import '@shikijs/twoslash/core';
+import 'twoslash';
+import 'twoslash-vue';
+import '@shikijs/twoslash';
+
+interface FileSystemTypeResultCacheOptions {
+    /**
+     * The directory to store the cache files.
+     *
+     * @default '.vitepress/cache/twoslash'
+     */
+    dir?: string;
+}
+declare function createFileSystemTypesCache(options?: FileSystemTypeResultCacheOptions): TwoslashTypesCache;
+
+export { type FileSystemTypeResultCacheOptions, createFileSystemTypesCache };

package/dist/cache-fs.mjs

@@ -0,0 +1,29 @@
+import { createHash } from 'node:crypto';
+import { mkdirSync, existsSync, readFileSync, writeFileSync } from 'node:fs';
+import { resolve, join } from 'node:path';
+import process from 'node:process';
+
+function createFileSystemTypesCache(options = {}) {
+  const dir = resolve(process.cwd(), options.dir ?? ".vitepress/cache/twoslash");
+  return {
+    init() {
+      mkdirSync(dir, { recursive: true });
+    },
+    read(code) {
+      const hash = createHash("SHA256").update(code).digest("hex").slice(0, 12);
+      const filePath = join(dir, `${hash}.json`);
+      if (!existsSync(filePath)) {
+        return null;
+      }
+      return JSON.parse(readFileSync(filePath, { encoding: "utf-8" }));
+    },
+    write(code, data) {
+      const hash = createHash("SHA256").update(code).digest("hex").slice(0, 12);
+      const filePath = join(dir, `${hash}.json`);
+      const json = JSON.stringify(data);
+      writeFileSync(filePath, json, { encoding: "utf-8" });
+    }
+  };
+}
+
+export { createFileSystemTypesCache };

package/dist/index.d.mts

@@ -1,36 +1,11 @@
-import { TransformerTwoslashOptions } from '@shikijs/twoslash/core';
 import { ShikiTransformer } from 'shiki';
-import { VueSpecificOptions } from 'twoslash-vue';
-import { RendererRichOptions, TwoslashRenderer } from '@shikijs/twoslash';
+import { V as VitePressPluginTwoslashOptions } from './shared/vitepress-twoslash.dfe2cbbb.mjs';
+export { T as TwoslashFloatingVueOptions, a as TwoslashFloatingVueRendererOptions, b as TwoslashTypesCache, r as rendererFloatingVue } from './shared/vitepress-twoslash.dfe2cbbb.mjs';
 export { defaultHoverInfoProcessor } from '@shikijs/twoslash';
+import '@shikijs/twoslash/core';
+import 'twoslash';
+import 'twoslash-vue';
 
-interface TwoslashFloatingVueOptions {
-    classCopyIgnore?: string;
-    classFloatingPanel?: string;
-    classCode?: string;
-    classMarkdown?: string;
-    floatingVueTheme?: string;
-    floatingVueThemeQuery?: string;
-    floatingVueThemeCompletion?: string;
-}
-interface TwoslashFloatingVueRendererOptions extends RendererRichOptions {
-    /**
-     * Class and themes for floating-vue specific nodes
-     */
-    floatingVue?: TwoslashFloatingVueOptions;
-}
-declare function rendererFloatingVue(options?: TwoslashFloatingVueRendererOptions): TwoslashRenderer;
-
-interface TransformerTwoslashVueOptions extends TransformerTwoslashOptions {
-    twoslashOptions?: TransformerTwoslashOptions['twoslashOptions'] & VueSpecificOptions;
-}
-interface VitePressPluginTwoslashOptions extends TransformerTwoslashVueOptions, TwoslashFloatingVueRendererOptions {
-    /**
-     * Requires adding `twoslash` to the code block explicitly to run twoslash
-     * @default true
-     */
-    explicitTrigger?: TransformerTwoslashOptions['explicitTrigger'];
-}
 /**
  * Create a Shiki transformer for VitePress to enable twoslash integration
  *
@@ -38,4 +13,4 @@ interface VitePressPluginTwoslashOptions extends TransformerTwoslashVueOptions,
  */
 declare function transformerTwoslash(options?: VitePressPluginTwoslashOptions): ShikiTransformer;
 
-export { type TwoslashFloatingVueOptions, type TwoslashFloatingVueRendererOptions, type VitePressPluginTwoslashOptions, rendererFloatingVue, transformerTwoslash };
+export { VitePressPluginTwoslashOptions, transformerTwoslash };

package/dist/index.d.ts

@@ -1,36 +1,11 @@
-import { TransformerTwoslashOptions } from '@shikijs/twoslash/core';
 import { ShikiTransformer } from 'shiki';
-import { VueSpecificOptions } from 'twoslash-vue';
-import { RendererRichOptions, TwoslashRenderer } from '@shikijs/twoslash';
+import { V as VitePressPluginTwoslashOptions } from './shared/vitepress-twoslash.dfe2cbbb.js';
+export { T as TwoslashFloatingVueOptions, a as TwoslashFloatingVueRendererOptions, b as TwoslashTypesCache, r as rendererFloatingVue } from './shared/vitepress-twoslash.dfe2cbbb.js';
 export { defaultHoverInfoProcessor } from '@shikijs/twoslash';
+import '@shikijs/twoslash/core';
+import 'twoslash';
+import 'twoslash-vue';
 
-interface TwoslashFloatingVueOptions {
-    classCopyIgnore?: string;
-    classFloatingPanel?: string;
-    classCode?: string;
-    classMarkdown?: string;
-    floatingVueTheme?: string;
-    floatingVueThemeQuery?: string;
-    floatingVueThemeCompletion?: string;
-}
-interface TwoslashFloatingVueRendererOptions extends RendererRichOptions {
-    /**
-     * Class and themes for floating-vue specific nodes
-     */
-    floatingVue?: TwoslashFloatingVueOptions;
-}
-declare function rendererFloatingVue(options?: TwoslashFloatingVueRendererOptions): TwoslashRenderer;
-
-interface TransformerTwoslashVueOptions extends TransformerTwoslashOptions {
-    twoslashOptions?: TransformerTwoslashOptions['twoslashOptions'] & VueSpecificOptions;
-}
-interface VitePressPluginTwoslashOptions extends TransformerTwoslashVueOptions, TwoslashFloatingVueRendererOptions {
-    /**
-     * Requires adding `twoslash` to the code block explicitly to run twoslash
-     * @default true
-     */
-    explicitTrigger?: TransformerTwoslashOptions['explicitTrigger'];
-}
 /**
  * Create a Shiki transformer for VitePress to enable twoslash integration
  *
@@ -38,4 +13,4 @@ interface VitePressPluginTwoslashOptions extends TransformerTwoslashVueOptions,
  */
 declare function transformerTwoslash(options?: VitePressPluginTwoslashOptions): ShikiTransformer;
 
-export { type TwoslashFloatingVueOptions, type TwoslashFloatingVueRendererOptions, type VitePressPluginTwoslashOptions, rendererFloatingVue, transformerTwoslash };
+export { VitePressPluginTwoslashOptions, transformerTwoslash };

package/dist/index.mjs

@@ -167,7 +167,8 @@ function compose(parts) {
 
 function transformerTwoslash(options = {}) {
   const {
-    explicitTrigger = true
+    explicitTrigger = true,
+    typesCache
   } = options;
   const onError = (error, code) => {
     const isCI = typeof process !== "undefined" && process?.env?.CI;
@@ -187,9 +188,20 @@ ${code.split(/\n/g).slice(0, 15).join("\n").trim()}
       console.error(error);
     removeTwoslashNotations(code);
   };
-  const twoslash = createTransformerFactory(
-    createTwoslasher(options.twoslashOptions)
-  )({
+  const defaultTwoslasher = createTwoslasher(options.twoslashOptions);
+  let twoslasher = defaultTwoslasher;
+  if (typesCache) {
+    twoslasher = (code, extension, options2) => {
+      const cached = typesCache.read(code);
+      if (cached)
+        return cached;
+      const twoslashResult = defaultTwoslasher(code, extension, options2);
+      typesCache.write(code, twoslashResult);
+      return twoslashResult;
+    };
+    twoslasher.getCacheMap = defaultTwoslasher.getCacheMap;
+  }
+  const twoslash = createTransformerFactory(twoslasher)({
     langs: ["ts", "tsx", "js", "jsx", "json", "vue"],
     renderer: rendererFloatingVue(options),
     onTwoslashError: onError,
@@ -198,6 +210,7 @@ ${code.split(/\n/g).slice(0, 15).join("\n").trim()}
     explicitTrigger
   });
   const trigger = explicitTrigger instanceof RegExp ? explicitTrigger : /\btwoslash\b/;
+  typesCache?.init?.();
   return {
     ...twoslash,
     name: "@shikijs/vitepress-twoslash",

package/dist/shared/vitepress-twoslash.dfe2cbbb.d.mts

@@ -0,0 +1,69 @@
+import { TransformerTwoslashOptions } from '@shikijs/twoslash/core';
+import { TwoslashReturn } from 'twoslash';
+import { VueSpecificOptions } from 'twoslash-vue';
+import { RendererRichOptions, TwoslashRenderer } from '@shikijs/twoslash';
+
+interface TwoslashFloatingVueOptions {
+    classCopyIgnore?: string;
+    classFloatingPanel?: string;
+    classCode?: string;
+    classMarkdown?: string;
+    floatingVueTheme?: string;
+    floatingVueThemeQuery?: string;
+    floatingVueThemeCompletion?: string;
+}
+interface TwoslashFloatingVueRendererOptions extends RendererRichOptions {
+    /**
+     * Class and themes for floating-vue specific nodes
+     */
+    floatingVue?: TwoslashFloatingVueOptions;
+}
+declare function rendererFloatingVue(options?: TwoslashFloatingVueRendererOptions): TwoslashRenderer;
+
+interface TransformerTwoslashVueOptions extends TransformerTwoslashOptions {
+    twoslashOptions?: TransformerTwoslashOptions['twoslashOptions'] & VueSpecificOptions;
+}
+interface VitePressPluginTwoslashOptions extends TransformerTwoslashVueOptions, TwoslashFloatingVueRendererOptions {
+    /**
+     * Requires adding `twoslash` to the code block explicitly to run twoslash
+     * @default true
+     */
+    explicitTrigger?: TransformerTwoslashOptions['explicitTrigger'];
+    /**
+     * The options for caching resolved types
+     *
+     * @example
+     * ```ts
+     * import { transformerTwoslash } from '@shikijs/vitepress-twoslash'
+     * import { createFileSystemTypesCache } from '@shikijs/vitepress-twoslash/cache-fs'
+     *
+     * transformerTwoslash({
+     *   typesCache: createFileSystemTypesCache({
+     *     dir: './my-cache-dir'
+     *   })
+     * })
+     * ```
+     */
+    typesCache?: TwoslashTypesCache;
+}
+interface TwoslashTypesCache {
+    /**
+     * Read cached result
+     *
+     * @param code Source code
+     */
+    read: (code: string) => TwoslashReturn | null;
+    /**
+     * Save result to cache
+     *
+     * @param code Source code
+     * @param data Twoslash data
+     */
+    write: (code: string, data: TwoslashReturn) => void;
+    /**
+     * On initialization
+     */
+    init?: () => void;
+}
+
+export { type TwoslashFloatingVueOptions as T, type VitePressPluginTwoslashOptions as V, type TwoslashFloatingVueRendererOptions as a, type TwoslashTypesCache as b, rendererFloatingVue as r };

package/dist/shared/vitepress-twoslash.dfe2cbbb.d.ts

@@ -0,0 +1,69 @@
+import { TransformerTwoslashOptions } from '@shikijs/twoslash/core';
+import { TwoslashReturn } from 'twoslash';
+import { VueSpecificOptions } from 'twoslash-vue';
+import { RendererRichOptions, TwoslashRenderer } from '@shikijs/twoslash';
+
+interface TwoslashFloatingVueOptions {
+    classCopyIgnore?: string;
+    classFloatingPanel?: string;
+    classCode?: string;
+    classMarkdown?: string;
+    floatingVueTheme?: string;
+    floatingVueThemeQuery?: string;
+    floatingVueThemeCompletion?: string;
+}
+interface TwoslashFloatingVueRendererOptions extends RendererRichOptions {
+    /**
+     * Class and themes for floating-vue specific nodes
+     */
+    floatingVue?: TwoslashFloatingVueOptions;
+}
+declare function rendererFloatingVue(options?: TwoslashFloatingVueRendererOptions): TwoslashRenderer;
+
+interface TransformerTwoslashVueOptions extends TransformerTwoslashOptions {
+    twoslashOptions?: TransformerTwoslashOptions['twoslashOptions'] & VueSpecificOptions;
+}
+interface VitePressPluginTwoslashOptions extends TransformerTwoslashVueOptions, TwoslashFloatingVueRendererOptions {
+    /**
+     * Requires adding `twoslash` to the code block explicitly to run twoslash
+     * @default true
+     */
+    explicitTrigger?: TransformerTwoslashOptions['explicitTrigger'];
+    /**
+     * The options for caching resolved types
+     *
+     * @example
+     * ```ts
+     * import { transformerTwoslash } from '@shikijs/vitepress-twoslash'
+     * import { createFileSystemTypesCache } from '@shikijs/vitepress-twoslash/cache-fs'
+     *
+     * transformerTwoslash({
+     *   typesCache: createFileSystemTypesCache({
+     *     dir: './my-cache-dir'
+     *   })
+     * })
+     * ```
+     */
+    typesCache?: TwoslashTypesCache;
+}
+interface TwoslashTypesCache {
+    /**
+     * Read cached result
+     *
+     * @param code Source code
+     */
+    read: (code: string) => TwoslashReturn | null;
+    /**
+     * Save result to cache
+     *
+     * @param code Source code
+     * @param data Twoslash data
+     */
+    write: (code: string, data: TwoslashReturn) => void;
+    /**
+     * On initialization
+     */
+    init?: () => void;
+}
+
+export { type TwoslashFloatingVueOptions as T, type VitePressPluginTwoslashOptions as V, type TwoslashFloatingVueRendererOptions as a, type TwoslashTypesCache as b, rendererFloatingVue as r };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@shikijs/vitepress-twoslash",
   "type": "module",
-  "version": "1.22.2",
+  "version": "1.23.0",
   "description": "Enable Twoslash support in VitePress",
   "author": "Anthony Fu <anthonyfu117@hotmail.com>",
   "license": "MIT",
@@ -27,6 +27,10 @@
       "types": "./dist/client.d.mts",
       "default": "./dist/client.mjs"
     },
+    "./cache-fs": {
+      "types": "./dist/cache-fs.d.mts",
+      "default": "./dist/cache-fs.mjs"
+    },
     "./style.css": "./style.css",
     "./style-core.css": "./style-core.css"
   },
@@ -56,7 +60,7 @@
     "twoslash": "^0.2.12",
     "twoslash-vue": "^0.2.12",
     "vue": "^3.5.12",
-    "shiki": "1.22.2"
+    "shiki": "1.23.0"
   },
   "scripts": {
     "build": "unbuild",