@shikijs/twoslash 3.11.0 → 3.12.0

package/dist/core.d.mts

@@ -1,4 +1,4 @@
-import { CodeToHastOptions, ShikiTransformerContext, ShikiTransformerContextCommon, ShikiTransformer } from '@shikijs/types';
+import { CodeToHastOptions, ShikiTransformerContext, ShikiTransformerContextMeta, ShikiTransformerContextCommon, ShikiTransformer } from '@shikijs/types';
 import { TwoslashReturn, TwoslashExecuteOptions, TwoslashGenericFunction, TwoslashOptions, NodeError, NodeTag, NodeQuery, NodeCompletion, NodeHover, NodeHighlight } from 'twoslash';
 import { ElementContent, Element, Text } from 'hast';
 
@@ -11,6 +11,26 @@ declare module '@shikijs/core' {
         twoslash?: TwoslashShikiReturn;
     }
 }
+interface TwoslashTypesCache {
+    /**
+     * On initialization
+     */
+    init?: () => void;
+    preprocess?: (code: string, lang?: string, options?: TwoslashExecuteOptions, meta?: ShikiTransformerContextMeta) => string | void;
+    /**
+     * Read cached result
+     *
+     * @param code Source code
+     */
+    read: (code: string, lang?: string, options?: TwoslashExecuteOptions, meta?: ShikiTransformerContextMeta) => TwoslashShikiReturn | null;
+    /**
+     * Save result to cache
+     *
+     * @param code Source code
+     * @param data Twoslash data
+     */
+    write: (code: string, data: TwoslashShikiReturn, lang?: string, options?: TwoslashExecuteOptions, meta?: ShikiTransformerContextMeta) => void;
+}
 interface TransformerTwoslashOptions {
     /**
      * Languages to apply this transformer to
@@ -70,6 +90,22 @@ interface TransformerTwoslashOptions {
      * When specified, `throws` will be ignored
      */
     onShikiError?: (error: unknown, code: string, lang: string) => void;
+    /**
+     * 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 TwoslashRenderer {
     lineError?: (this: ShikiTransformerContext, error: NodeError) => ElementContent[];
@@ -287,4 +323,4 @@ declare function defaultTwoslashOptions(): TwoslashExecuteOptions;
 declare function createTransformerFactory(defaultTwoslasher: TwoslashShikiFunction | TwoslashGenericFunction, defaultRenderer?: TwoslashRenderer): (options?: TransformerTwoslashOptions) => ShikiTransformer;
 
 export { ShikiTwoslashError, createTransformerFactory, defaultCompletionIcons, defaultCustomTagIcons, defaultHoverInfoProcessor, defaultTwoslashOptions, rendererClassic, rendererRich };
-export type { CompletionItem, HastExtension, RendererRichOptions, TransformerTwoslashOptions, TwoslashRenderer, TwoslashShikiFunction, TwoslashShikiReturn };
+export type { CompletionItem, HastExtension, RendererRichOptions, TransformerTwoslashOptions, TwoslashRenderer, TwoslashShikiFunction, TwoslashShikiReturn, TwoslashTypesCache };

package/dist/core.mjs

@@ -1103,7 +1103,8 @@ function createTransformerFactory(defaultTwoslasher, defaultRenderer) {
       disableTriggers = ["notwoslash", "no-twoslash"],
       renderer = defaultRenderer,
       throws = true,
-      includesMap = /* @__PURE__ */ new Map()
+      includesMap = /* @__PURE__ */ new Map(),
+      typesCache
     } = options;
     const onTwoslashError = options.onTwoslashError || (throws ? (error) => {
       throw error;
@@ -1121,6 +1122,21 @@ function createTransformerFactory(defaultTwoslasher, defaultRenderer) {
       }
     } = options;
     const includes = new TwoslashIncludesManager(includesMap);
+    let _twoslasher = twoslasher;
+    if (typesCache) {
+      _twoslasher = ((code, lang, options2, meta) => {
+        const preprocessed = typesCache?.preprocess?.(code, lang, options2, meta);
+        if (preprocessed !== void 0)
+          code = preprocessed;
+        let twoslash = typesCache?.read(code, lang, options2, meta);
+        if (!twoslash) {
+          twoslash = twoslasher(code, lang, options2);
+          typesCache?.write(code, twoslash, lang, options2, meta);
+        }
+        return twoslash;
+      });
+      typesCache.init?.();
+    }
     return {
       preprocess(code) {
         let lang = this.options.lang;
@@ -1132,7 +1148,7 @@ function createTransformerFactory(defaultTwoslasher, defaultRenderer) {
             const include = parseIncludeMeta(this.options.meta?.__raw);
             if (include)
               includes.add(include, codeWithIncludes);
-            const twoslash = twoslasher(codeWithIncludes, lang, twoslashOptions);
+            const twoslash = _twoslasher(codeWithIncludes, lang, twoslashOptions, this.meta);
             map.set(this.meta, twoslash);
             this.meta.twoslash = twoslash;
             this.options.lang = twoslash.meta?.extension || lang;

package/dist/index.d.mts

@@ -1,7 +1,7 @@
 import { ShikiTransformer } 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';
+export { CompletionItem, HastExtension, ShikiTwoslashError, TwoslashRenderer, TwoslashShikiFunction, TwoslashShikiReturn, TwoslashTypesCache, createTransformerFactory, defaultCompletionIcons, defaultCustomTagIcons, defaultHoverInfoProcessor, defaultTwoslashOptions, rendererClassic, rendererRich } from './core.mjs';
 import 'hast';
 
 interface TransformerTwoslashIndexOptions extends TransformerTwoslashOptions, Pick<CreateTwoslashOptions, 'cache'> {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@shikijs/twoslash",
   "type": "module",
-  "version": "3.11.0",
+  "version": "3.12.0",
   "description": "Shiki transformer for twoslash",
   "author": "Anthony Fu <anthonyfu117@hotmail.com>",
   "license": "MIT",
@@ -36,15 +36,15 @@
   },
   "dependencies": {
     "twoslash": "^0.3.4",
-    "@shikijs/core": "3.11.0",
-    "@shikijs/types": "3.11.0"
+    "@shikijs/core": "3.12.0",
+    "@shikijs/types": "3.12.0"
   },
   "devDependencies": {
     "@iconify-json/carbon": "^1.2.13",
-    "@iconify-json/codicon": "^1.2.25",
+    "@iconify-json/codicon": "^1.2.26",
     "hast-util-from-html": "^2.0.3",
     "typescript": "^5.9.2",
-    "@shikijs/twoslash": "3.11.0"
+    "@shikijs/twoslash": "3.12.0"
   },
   "scripts": {
     "build": "unbuild",