@shikijs/twoslash 1.13.0 → 1.14.0

package/dist/core.d.mts

@@ -43,6 +43,11 @@ interface TransformerTwoslashOptions {
      * Custom renderers to decide how each info should be rendered
      */
     renderer?: TwoslashRenderer;
+    /**
+     * A map to store code for `@include` directive
+     * Provide your own instance if you want to clear the map between each transformation
+     */
+    includesMap?: Map<string, string>;
     /**
      * Strictly throw when there is an error
      * @default true

package/dist/core.d.ts

@@ -43,6 +43,11 @@ interface TransformerTwoslashOptions {
      * Custom renderers to decide how each info should be rendered
      */
     renderer?: TwoslashRenderer;
+    /**
+     * A map to store code for `@include` directive
+     * Provide your own instance if you want to clear the map between each transformation
+     */
+    includesMap?: Map<string, string>;
     /**
      * Strictly throw when there is an error
      * @default true

package/dist/core.mjs

@@ -7,6 +7,52 @@ class ShikiTwoslashError extends Error {
   }
 }
 
+class TwoslashIncludesManager {
+  constructor(map = /* @__PURE__ */ new Map()) {
+    this.map = map;
+  }
+  add(name, code) {
+    const lines = [];
+    code.split("\n").forEach((l, _i) => {
+      const trimmed = l.trim();
+      if (trimmed.startsWith("// - ")) {
+        const key = trimmed.split("// - ")[1].split(" ")[0];
+        this.map.set(`${name}-${key}`, lines.join("\n"));
+      } else {
+        lines.push(l);
+      }
+    });
+    this.map.set(name, lines.join("\n"));
+  }
+  applyInclude(code) {
+    const reMarker = /\/\/ @include: (.*)$/gm;
+    const toReplace = [];
+    for (const match of code.matchAll(reMarker)) {
+      const key = match[1];
+      const replaceWith = this.map.get(key);
+      if (!replaceWith) {
+        const msg = `Could not find an include with the key: '${key}'.
+There is: ${Array.from(this.map.keys())}.`;
+        throw new Error(msg);
+      } else {
+        toReplace.push([match.index, match[0].length, replaceWith]);
+      }
+    }
+    let newCode = code.toString();
+    toReplace.reverse().forEach((r) => {
+      newCode = newCode.slice(0, r[0]) + r[2] + newCode.slice(r[0] + r[1]);
+    });
+    return newCode;
+  }
+}
+const INCLUDE_META_REGEX = /include\s+([\w-]+)\b.*/;
+function parseIncludeMeta(meta) {
+  if (!meta)
+    return null;
+  const match = meta.match(INCLUDE_META_REGEX);
+  return match?.[1] ?? null;
+}
+
 const module = {
 	type: "element",
 	tagName: "svg",
@@ -1046,7 +1092,8 @@ function createTransformerFactory(defaultTwoslasher, defaultRenderer) {
       twoslasher = defaultTwoslasher,
       explicitTrigger = false,
       renderer = defaultRenderer,
-      throws = true
+      throws = true,
+      includesMap = /* @__PURE__ */ new Map()
     } = options;
     const onTwoslashError = options.onTwoslashError || (throws ? (error) => {
       throw error;
@@ -1059,6 +1106,7 @@ function createTransformerFactory(defaultTwoslasher, defaultRenderer) {
       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 || "")));
+    const includes = new TwoslashIncludesManager(includesMap);
     return {
       preprocess(code) {
         let lang = this.options.lang;
@@ -1066,7 +1114,11 @@ function createTransformerFactory(defaultTwoslasher, defaultRenderer) {
           lang = langAlias[this.options.lang];
         if (filter(lang, code, this.options)) {
           try {
-            const twoslash = twoslasher(code, lang, twoslashOptions);
+            const include = parseIncludeMeta(this.options.meta?.__raw);
+            if (include)
+              includes.add(include, code);
+            const codeWithIncludes = includes.applyInclude(code);
+            const twoslash = twoslasher(codeWithIncludes, lang, twoslashOptions);
             map.set(this.meta, twoslash);
             this.meta.twoslash = twoslash;
             this.options.lang = twoslash.meta?.extension || lang;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@shikijs/twoslash",
   "type": "module",
-  "version": "1.13.0",
+  "version": "1.14.0",
   "description": "Shiki transformer for twoslash",
   "author": "Anthony Fu <anthonyfu117@hotmail.com>",
   "license": "MIT",
@@ -50,7 +50,7 @@
   ],
   "dependencies": {
     "twoslash": "^0.2.9",
-    "@shikijs/core": "1.13.0"
+    "@shikijs/core": "1.14.0"
   },
   "devDependencies": {
     "@iconify-json/carbon": "^1.1.37",