@shikijs/transformers 3.12.2 → 3.13.0

package/dist/index.d.mts

@@ -150,6 +150,15 @@ declare function transformerRemoveLineBreak(): ShikiTransformer$1;
  */
 declare function transformerRemoveNotationEscape(): ShikiTransformer$1;
 
+interface TransformerRenderIndentGuidesOptions {
+    indent?: number;
+}
+/**
+ * Render indentations as separate tokens.
+ * Apply with CSS, it can be used to render indent guides visually.
+ */
+declare function transformerRenderIndentGuides(options?: TransformerRenderIndentGuidesOptions): ShikiTransformer$1;
+
 interface TransformerRenderWhitespaceOptions {
     /**
      * Class for tab
@@ -203,5 +212,5 @@ interface ShikiTransformerStyleToClass extends ShikiTransformer$1 {
  */
 declare function transformerStyleToClass(options?: TransformerStyleToClassOptions): ShikiTransformerStyleToClass;
 
-export { createCommentNotationTransformer, findAllSubstringIndexes, parseMetaHighlightString, parseMetaHighlightWords, transformerCompactLineOptions, transformerMetaHighlight, transformerMetaWordHighlight, transformerNotationDiff, transformerNotationErrorLevel, transformerNotationFocus, transformerNotationHighlight, transformerNotationMap, transformerNotationWordHighlight, transformerRemoveLineBreak, transformerRemoveNotationEscape, transformerRenderWhitespace, transformerStyleToClass };
-export type { ShikiTransformerStyleToClass, TransformerCompactLineOption, TransformerMetaHighlightOptions, TransformerMetaWordHighlightOptions, TransformerNotationDiffOptions, TransformerNotationErrorLevelOptions, TransformerNotationFocusOptions, TransformerNotationHighlightOptions, TransformerNotationMapOptions, TransformerNotationWordHighlightOptions, TransformerRenderWhitespaceOptions, TransformerStyleToClassOptions };
+export { createCommentNotationTransformer, findAllSubstringIndexes, parseMetaHighlightString, parseMetaHighlightWords, transformerCompactLineOptions, transformerMetaHighlight, transformerMetaWordHighlight, transformerNotationDiff, transformerNotationErrorLevel, transformerNotationFocus, transformerNotationHighlight, transformerNotationMap, transformerNotationWordHighlight, transformerRemoveLineBreak, transformerRemoveNotationEscape, transformerRenderIndentGuides, transformerRenderWhitespace, transformerStyleToClass };
+export type { ShikiTransformerStyleToClass, TransformerCompactLineOption, TransformerMetaHighlightOptions, TransformerMetaWordHighlightOptions, TransformerNotationDiffOptions, TransformerNotationErrorLevelOptions, TransformerNotationFocusOptions, TransformerNotationHighlightOptions, TransformerNotationMapOptions, TransformerNotationWordHighlightOptions, TransformerRenderIndentGuidesOptions, TransformerRenderWhitespaceOptions, TransformerStyleToClassOptions };

package/dist/index.mjs

@@ -485,6 +485,73 @@ function transformerRemoveNotationEscape() {
   };
 }
 
+function transformerRenderIndentGuides(options = {}) {
+  return {
+    name: "@shikijs/transformers:render-indent-guides",
+    code(hast) {
+      let { indent = 2 } = options;
+      const match = this.options.meta?.__raw?.match(/\{indent:(\d+|false)\}/);
+      if (match) {
+        if (match[1] === "false") {
+          return hast;
+        }
+        indent = Number(match[1]);
+      }
+      const indentRegex = new RegExp(` {${indent}}| {0,${indent - 1}}	| {1,}$`, "g");
+      const emptyLines = [];
+      let level = 0;
+      for (const line of hast.children) {
+        if (line.type !== "element") {
+          continue;
+        }
+        const first = line.children[0];
+        if (first?.type !== "element" || first?.children[0]?.type !== "text") {
+          emptyLines.push([line, level]);
+          continue;
+        }
+        const text = first.children[0];
+        const blanks = text.value.split(/[^ \t]/, 1)[0];
+        const ranges = [];
+        for (const match2 of blanks.matchAll(indentRegex)) {
+          const start = match2.index;
+          const end = start + match2[0].length;
+          ranges.push([start, end]);
+        }
+        for (const [line2, level2] of emptyLines) {
+          line2.children.unshift(...Array.from({ length: Math.min(ranges.length, level2 + 1) }, (_, i) => ({
+            type: "element",
+            tagName: "span",
+            properties: {
+              class: "indent",
+              style: `--indent-offset: ${i * indent}ch;`
+            },
+            children: []
+          })));
+        }
+        emptyLines.length = 0;
+        level = ranges.length;
+        if (ranges.length) {
+          line.children.unshift(
+            ...ranges.map(([start, end]) => ({
+              type: "element",
+              tagName: "span",
+              properties: {
+                class: "indent"
+              },
+              children: [{
+                type: "text",
+                value: text.value.slice(start, end)
+              }]
+            }))
+          );
+          text.value = text.value.slice(ranges.at(-1)[1]);
+        }
+      }
+      return hast;
+    }
+  };
+}
+
 function isTab(part) {
   return part === "	";
 }
@@ -674,4 +741,4 @@ function cyrb53(str, seed = 0) {
   return (4294967296 * (2097151 & h2) + (h1 >>> 0)).toString(36).slice(0, 6);
 }
 
-export { createCommentNotationTransformer, findAllSubstringIndexes, parseMetaHighlightString, parseMetaHighlightWords, transformerCompactLineOptions, transformerMetaHighlight, transformerMetaWordHighlight, transformerNotationDiff, transformerNotationErrorLevel, transformerNotationFocus, transformerNotationHighlight, transformerNotationMap, transformerNotationWordHighlight, transformerRemoveLineBreak, transformerRemoveNotationEscape, transformerRenderWhitespace, transformerStyleToClass };
+export { createCommentNotationTransformer, findAllSubstringIndexes, parseMetaHighlightString, parseMetaHighlightWords, transformerCompactLineOptions, transformerMetaHighlight, transformerMetaWordHighlight, transformerNotationDiff, transformerNotationErrorLevel, transformerNotationFocus, transformerNotationHighlight, transformerNotationMap, transformerNotationWordHighlight, transformerRemoveLineBreak, transformerRemoveNotationEscape, transformerRenderIndentGuides, transformerRenderWhitespace, transformerStyleToClass };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@shikijs/transformers",
   "type": "module",
-  "version": "3.12.2",
+  "version": "3.13.0",
   "description": "Collective of common transformers transformers for Shiki",
   "author": "Anthony Fu <anthonyfu117@hotmail.com>",
   "license": "MIT",
@@ -27,8 +27,8 @@
     "dist"
   ],
   "dependencies": {
-    "@shikijs/types": "3.12.2",
-    "@shikijs/core": "3.12.2"
+    "@shikijs/core": "3.13.0",
+    "@shikijs/types": "3.13.0"
   },
   "scripts": {
     "build": "unbuild",