@shikijs/transformers 3.17.1 → 3.19.0

package/dist/index.d.mts

@@ -34,6 +34,12 @@ interface TransformerMetaHighlightOptions {
      * @default 'highlighted'
      */
     className?: string;
+    /**
+     * Interpret line numbers as 0-indexed
+     *
+     * @default false
+     */
+    zeroIndexed?: boolean;
 }
 /**
  * Allow using `{1,3-5}` in the code snippet meta to mark highlighted lines.
@@ -68,6 +74,10 @@ interface TransformerNotationDiffOptions extends MatchAlgorithmOptions {
      * Class added to the <pre> element when the current code has diff
      */
     classActivePre?: string;
+    /**
+     * Class added to the <code> element when the current code has diff
+     */
+    classActiveCode?: string;
 }
 /**
  * Use `[!code ++]` and `[!code --]` to mark added and removed lines.
@@ -80,6 +90,10 @@ interface TransformerNotationErrorLevelOptions extends MatchAlgorithmOptions {
      * Class added to the <pre> element when the current code has diff
      */
     classActivePre?: string;
+    /**
+     * Class added to the <code> element when the current code has diff
+     */
+    classActiveCode?: string;
 }
 /**
  * Allow using `[!code error]` `[!code warning]` notation in code to mark highlighted lines.
@@ -95,6 +109,10 @@ interface TransformerNotationFocusOptions extends MatchAlgorithmOptions {
      * Class added to the root element when the code has focused lines
      */
     classActivePre?: string;
+    /**
+     * Class added to the <code> element when the code has focused lines
+     */
+    classActiveCode?: string;
 }
 /**
  * Allow using `[!code focus]` notation in code to mark focused lines.
@@ -110,6 +128,10 @@ interface TransformerNotationHighlightOptions extends MatchAlgorithmOptions {
      * Class added to the root element when the code has highlighted lines
      */
     classActivePre?: string;
+    /**
+     * Class added to the <code> element when the code has highlighted lines
+     */
+    classActiveCode?: string;
 }
 /**
  * Allow using `[!code highlight]` notation in code to mark highlighted lines.
@@ -134,9 +156,25 @@ interface TransformerNotationMapOptions extends MatchAlgorithmOptions {
      * Class added to the <pre> element when the current code has diff
      */
     classActivePre?: string;
+    /**
+     * Class added to the <code> element when the current code has diff
+     */
+    classActiveCode?: string;
 }
 declare function transformerNotationMap(options?: TransformerNotationMapOptions, name?: string): ShikiTransformer$1;
 
+interface TransformerRemoveCommentsOptions {
+    /**
+     * Remove lines that become empty after removing comments.
+     * @default true
+     */
+    removeEmptyLines?: boolean;
+}
+/**
+ * Remove comments from the code.
+ */
+declare function transformerRemoveComments(options?: TransformerRemoveCommentsOptions): ShikiTransformer$1;
+
 /**
  * Remove line breaks between lines.
  * Useful when you override `display: block` to `.line` in CSS.
@@ -212,5 +250,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, transformerRenderIndentGuides, transformerRenderWhitespace, transformerStyleToClass };
-export type { ShikiTransformerStyleToClass, TransformerCompactLineOption, TransformerMetaHighlightOptions, TransformerMetaWordHighlightOptions, TransformerNotationDiffOptions, TransformerNotationErrorLevelOptions, TransformerNotationFocusOptions, TransformerNotationHighlightOptions, TransformerNotationMapOptions, TransformerNotationWordHighlightOptions, TransformerRenderIndentGuidesOptions, TransformerRenderWhitespaceOptions, TransformerStyleToClassOptions };
+export { createCommentNotationTransformer, findAllSubstringIndexes, parseMetaHighlightString, parseMetaHighlightWords, transformerCompactLineOptions, transformerMetaHighlight, transformerMetaWordHighlight, transformerNotationDiff, transformerNotationErrorLevel, transformerNotationFocus, transformerNotationHighlight, transformerNotationMap, transformerNotationWordHighlight, transformerRemoveComments, transformerRemoveLineBreak, transformerRemoveNotationEscape, transformerRenderIndentGuides, transformerRenderWhitespace, transformerStyleToClass };
+export type { ShikiTransformerStyleToClass, TransformerCompactLineOption, TransformerMetaHighlightOptions, TransformerMetaWordHighlightOptions, TransformerNotationDiffOptions, TransformerNotationErrorLevelOptions, TransformerNotationFocusOptions, TransformerNotationHighlightOptions, TransformerNotationMapOptions, TransformerNotationWordHighlightOptions, TransformerRemoveCommentsOptions, TransformerRenderIndentGuidesOptions, TransformerRenderWhitespaceOptions, TransformerStyleToClassOptions };

package/dist/index.mjs

@@ -241,28 +241,24 @@ function parseMetaHighlightString(meta) {
   if (!match)
     return null;
   const lines = match[1].split(",").flatMap((v) => {
-    const num = v.split("-").map((v2) => Number.parseInt(v2, 10));
-    if (num.length === 1)
-      return [num[0]];
-    return Array.from({ length: num[1] - num[0] + 1 }, (_, i) => i + num[0]);
+    const range = v.split("-").map((n) => Number.parseInt(n, 10));
+    return range.length === 1 ? [range[0]] : Array.from({ length: range[1] - range[0] + 1 }, (_, i) => range[0] + i);
   });
   return lines;
 }
 const symbol = Symbol("highlighted-lines");
 function transformerMetaHighlight(options = {}) {
-  const {
-    className = "highlighted"
-  } = options;
+  const { className = "highlighted", zeroIndexed = false } = options;
   return {
     name: "@shikijs/transformers:meta-highlight",
-    line(node, line) {
-      if (!this.options.meta?.__raw) {
+    line(node, lineNumber) {
+      if (!this.options.meta?.__raw)
         return;
-      }
       const meta = this.meta;
       meta[symbol] ??= parseMetaHighlightString(this.options.meta.__raw);
-      const lines = meta[symbol] ?? [];
-      if (lines.includes(line))
+      const highlightedLines = meta[symbol] ?? [];
+      const effectiveLine = zeroIndexed ? lineNumber - 1 : lineNumber;
+      if (highlightedLines.includes(effectiveLine))
         this.addClassToHast(node, className);
       return node;
     }
@@ -322,7 +318,8 @@ function escapeRegExp(str) {
 function transformerNotationMap(options = {}, name = "@shikijs/transformers:notation-map") {
   const {
     classMap = {},
-    classActivePre = void 0
+    classActivePre = void 0,
+    classActiveCode = void 0
   } = options;
   return createCommentNotationTransformer(
     name,
@@ -334,6 +331,8 @@ function transformerNotationMap(options = {}, name = "@shikijs/transformers:nota
       }
       if (classActivePre)
         this.addClassToHast(this.pre, classActivePre);
+      if (classActiveCode)
+        this.addClassToHast(this.code, classActiveCode);
       return true;
     },
     options.matchAlgorithm
@@ -344,7 +343,8 @@ function transformerNotationDiff(options = {}) {
   const {
     classLineAdd = "diff add",
     classLineRemove = "diff remove",
-    classActivePre = "has-diff"
+    classActivePre = "has-diff",
+    classActiveCode
   } = options;
   return transformerNotationMap(
     {
@@ -353,6 +353,7 @@ function transformerNotationDiff(options = {}) {
         "--": classLineRemove
       },
       classActivePre,
+      classActiveCode,
       matchAlgorithm: options.matchAlgorithm
     },
     "@shikijs/transformers:notation-diff"
@@ -365,12 +366,14 @@ function transformerNotationErrorLevel(options = {}) {
       error: ["highlighted", "error"],
       warning: ["highlighted", "warning"]
     },
-    classActivePre = "has-highlighted"
+    classActivePre = "has-highlighted",
+    classActiveCode
   } = options;
   return transformerNotationMap(
     {
       classMap,
       classActivePre,
+      classActiveCode,
       matchAlgorithm: options.matchAlgorithm
     },
     "@shikijs/transformers:notation-error-level"
@@ -380,7 +383,8 @@ function transformerNotationErrorLevel(options = {}) {
 function transformerNotationFocus(options = {}) {
   const {
     classActiveLine = "focused",
-    classActivePre = "has-focused"
+    classActivePre = "has-focused",
+    classActiveCode
   } = options;
   return transformerNotationMap(
     {
@@ -388,6 +392,7 @@ function transformerNotationFocus(options = {}) {
         focus: classActiveLine
       },
       classActivePre,
+      classActiveCode,
       matchAlgorithm: options.matchAlgorithm
     },
     "@shikijs/transformers:notation-focus"
@@ -397,7 +402,8 @@ function transformerNotationFocus(options = {}) {
 function transformerNotationHighlight(options = {}) {
   const {
     classActiveLine = "highlighted",
-    classActivePre = "has-highlighted"
+    classActivePre = "has-highlighted",
+    classActiveCode
   } = options;
   return transformerNotationMap(
     {
@@ -406,6 +412,7 @@ function transformerNotationHighlight(options = {}) {
         hl: classActiveLine
       },
       classActivePre,
+      classActiveCode,
       matchAlgorithm: options.matchAlgorithm
     },
     "@shikijs/transformers:notation-highlight"
@@ -501,6 +508,41 @@ function transformerNotationWordHighlight(options = {}) {
   );
 }
 
+function transformerRemoveComments(options = {}) {
+  const { removeEmptyLines = true } = options;
+  return {
+    name: "@shikijs/transformers:remove-comments",
+    preprocess(_code, options2) {
+      if (options2.includeExplanation !== true && options2.includeExplanation !== "scopeName")
+        throw new Error("`transformerRemoveComments` requires `includeExplanation` to be set to `true` or `'scopeName'`");
+    },
+    tokens(tokens) {
+      const result = [];
+      for (const line of tokens) {
+        const filteredLine = [];
+        let hasComment = false;
+        for (const token of line) {
+          const isComment = token.explanation?.some(
+            (exp) => exp.scopes.some((s) => s.scopeName.startsWith("comment"))
+          );
+          if (isComment) {
+            hasComment = true;
+          } else {
+            filteredLine.push(token);
+          }
+        }
+        if (removeEmptyLines && hasComment) {
+          const isAllWhitespace = filteredLine.every((token) => !token.content.trim());
+          if (isAllWhitespace)
+            continue;
+        }
+        result.push(filteredLine);
+      }
+      return result;
+    }
+  };
+}
+
 function transformerRemoveLineBreak() {
   return {
     name: "@shikijs/transformers:remove-line-break",
@@ -783,4 +825,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, transformerRenderIndentGuides, transformerRenderWhitespace, transformerStyleToClass };
+export { createCommentNotationTransformer, findAllSubstringIndexes, parseMetaHighlightString, parseMetaHighlightWords, transformerCompactLineOptions, transformerMetaHighlight, transformerMetaWordHighlight, transformerNotationDiff, transformerNotationErrorLevel, transformerNotationFocus, transformerNotationHighlight, transformerNotationMap, transformerNotationWordHighlight, transformerRemoveComments, transformerRemoveLineBreak, transformerRemoveNotationEscape, transformerRenderIndentGuides, transformerRenderWhitespace, transformerStyleToClass };

package/package.json

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