@shikijs/transformers - npm Package Compare versions

Comparing version 2.1.0 to 2.2.0

dist/index.d.ts

@@ -1,3 +0,17 @@
-import { ShikiTransformer } from '@shikijs/types';
+import { ShikiTransformerContext, ShikiTransformer } from '@shikijs/core';
+import { Element } from 'hast';
+import { ShikiTransformer as ShikiTransformer$1 } from '@shikijs/types';
 
+type MatchAlgorithm = 'v1' | 'v3';
+interface MatchAlgorithmOptions {
+    /**
+     * Match algorithm to use
+     *
+     * @see https://shiki.style/packages/transformers#matching-algorithm
+     * @default 'v1'
+     */
+    matchAlgorithm?: MatchAlgorithm;
+}
+declare function createCommentNotationTransformer(name: string, regex: RegExp, onMatch: (this: ShikiTransformerContext, match: string[], line: Element, commentNode: Element, lines: Element[], index: number) => boolean, matchAlgorithm: MatchAlgorithm | undefined): ShikiTransformer;
+
 interface TransformerCompactLineOption {
@@ -13,3 +27,3 @@ /**
  */
-declare function transformerCompactLineOptions(lineOptions?: TransformerCompactLineOption[]): ShikiTransformer;
+declare function transformerCompactLineOptions(lineOptions?: TransformerCompactLineOption[]): ShikiTransformer$1;
 
@@ -28,3 +42,3 @@ declare function parseMetaHighlightString(meta: string): number[] | null;
  */
-declare function transformerMetaHighlight(options?: TransformerMetaHighlightOptions): ShikiTransformer;
+declare function transformerMetaHighlight(options?: TransformerMetaHighlightOptions): ShikiTransformer$1;
 
@@ -43,15 +57,4 @@ declare function parseMetaHighlightWords(meta: string): string[];
  */
-declare function transformerMetaWordHighlight(options?: TransformerMetaWordHighlightOptions): ShikiTransformer;
+declare function transformerMetaWordHighlight(options?: TransformerMetaWordHighlightOptions): ShikiTransformer$1;
 
-type MatchAlgorithm = 'v1' | 'v3';
-interface MatchAlgorithmOptions {
-    /**
-     * Match algorithm to use
-     *
-     * @see https://shiki.style/packages/transformers#matching-algorithm
-     * @default 'v1'
-     */
-    matchAlgorithm?: MatchAlgorithm;
-}
-
 interface TransformerNotationDiffOptions extends MatchAlgorithmOptions {
@@ -74,3 +77,3 @@ /**
  */
-declare function transformerNotationDiff(options?: TransformerNotationDiffOptions): ShikiTransformer;
+declare function transformerNotationDiff(options?: TransformerNotationDiffOptions): ShikiTransformer$1;
 
@@ -87,3 +90,3 @@ interface TransformerNotationErrorLevelOptions extends MatchAlgorithmOptions {
  */
-declare function transformerNotationErrorLevel(options?: TransformerNotationErrorLevelOptions): ShikiTransformer;
+declare function transformerNotationErrorLevel(options?: TransformerNotationErrorLevelOptions): ShikiTransformer$1;
 
@@ -103,3 +106,3 @@ interface TransformerNotationFocusOptions extends MatchAlgorithmOptions {
  */
-declare function transformerNotationFocus(options?: TransformerNotationFocusOptions): ShikiTransformer;
+declare function transformerNotationFocus(options?: TransformerNotationFocusOptions): ShikiTransformer$1;
 
@@ -119,3 +122,3 @@ interface TransformerNotationHighlightOptions extends MatchAlgorithmOptions {
  */
-declare function transformerNotationHighlight(options?: TransformerNotationHighlightOptions): ShikiTransformer;
+declare function transformerNotationHighlight(options?: TransformerNotationHighlightOptions): ShikiTransformer$1;
 
@@ -132,3 +135,3 @@ interface TransformerNotationWordHighlightOptions extends MatchAlgorithmOptions {
 }
-declare function transformerNotationWordHighlight(options?: TransformerNotationWordHighlightOptions): ShikiTransformer;
+declare function transformerNotationWordHighlight(options?: TransformerNotationWordHighlightOptions): ShikiTransformer$1;
 
@@ -142,3 +145,3 @@ interface TransformerNotationMapOptions extends MatchAlgorithmOptions {
 }
-declare function transformerNotationMap(options?: TransformerNotationMapOptions, name?: string): ShikiTransformer;
+declare function transformerNotationMap(options?: TransformerNotationMapOptions, name?: string): ShikiTransformer$1;
 
@@ -149,3 +152,3 @@ /**
  */
-declare function transformerRemoveLineBreak(): ShikiTransformer;
+declare function transformerRemoveLineBreak(): ShikiTransformer$1;
 
@@ -157,3 +160,3 @@ /**
  */
-declare function transformerRemoveNotationEscape(): ShikiTransformer;
+declare function transformerRemoveNotationEscape(): ShikiTransformer$1;
 
@@ -183,3 +186,3 @@ interface TransformerRenderWhitespaceOptions {
  */
-declare function transformerRenderWhitespace(options?: TransformerRenderWhitespaceOptions): ShikiTransformer;
+declare function transformerRenderWhitespace(options?: TransformerRenderWhitespaceOptions): ShikiTransformer$1;
 
@@ -203,3 +206,3 @@ interface TransformerStyleToClassOptions {
 }
-interface ShikiTransformerStyleToClass extends ShikiTransformer {
+interface ShikiTransformerStyleToClass extends ShikiTransformer$1 {
     getClassRegistry: () => Map<string, Record<string, string> | string>;
@@ -215,2 +218,2 @@ getCSS: () => string;
 
-export { type ShikiTransformerStyleToClass, type TransformerCompactLineOption, type TransformerMetaHighlightOptions, type TransformerMetaWordHighlightOptions, type TransformerNotationDiffOptions, type TransformerNotationErrorLevelOptions, type TransformerNotationFocusOptions, type TransformerNotationHighlightOptions, type TransformerNotationMapOptions, type TransformerNotationWordHighlightOptions, type TransformerRenderWhitespaceOptions, type TransformerStyleToClassOptions, parseMetaHighlightString, parseMetaHighlightWords, transformerCompactLineOptions, transformerMetaHighlight, transformerMetaWordHighlight, transformerNotationDiff, transformerNotationErrorLevel, transformerNotationFocus, transformerNotationHighlight, transformerNotationMap, transformerNotationWordHighlight, transformerRemoveLineBreak, transformerRemoveNotationEscape, transformerRenderWhitespace, transformerStyleToClass };
+export { type ShikiTransformerStyleToClass, type TransformerCompactLineOption, type TransformerMetaHighlightOptions, type TransformerMetaWordHighlightOptions, type TransformerNotationDiffOptions, type TransformerNotationErrorLevelOptions, type TransformerNotationFocusOptions, type TransformerNotationHighlightOptions, type TransformerNotationMapOptions, type TransformerNotationWordHighlightOptions, type TransformerRenderWhitespaceOptions, type TransformerStyleToClassOptions, createCommentNotationTransformer, parseMetaHighlightString, parseMetaHighlightWords, transformerCompactLineOptions, transformerMetaHighlight, transformerMetaWordHighlight, transformerNotationDiff, transformerNotationErrorLevel, transformerNotationFocus, transformerNotationHighlight, transformerNotationMap, transformerNotationWordHighlight, transformerRemoveLineBreak, transformerRemoveNotationEscape, transformerRenderWhitespace, transformerStyleToClass };

package.json

 {
   "name": "@shikijs/transformers",
   "type": "module",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "Collective of common transformers transformers for Shiki",
@@ -33,4 +33,4 @@ "author": "Anthony Fu <[e-mail]>",
   "dependencies": {
-    "@shikijs/core": "2.1.0",
-    "@shikijs/types": "2.1.0"
+    "@shikijs/core": "2.2.0",
+    "@shikijs/types": "2.2.0"
   },
@@ -37,0 +37,0 @@ "scripts": {

No alert changes

Improved metrics

Total package byte prevSize

35884

increased by2.8%

Lines of code

797

increased by0.38%

Dependency changes

• + Added@shikijs/core@2.2.0(transitive)

• + Added@shikijs/engine-javascript@2.2.0(transitive)

• + Added@shikijs/engine-oniguruma@2.2.0(transitive)

• + Added@shikijs/types@2.2.0(transitive)

• - Removed@shikijs/core@2.1.0(transitive)

• - Removed@shikijs/engine-javascript@2.1.0(transitive)

• - Removed@shikijs/engine-oniguruma@2.1.0(transitive)

• - Removed@shikijs/types@2.1.0(transitive)

• Updated@shikijs/core@2.2.0

• Updated@shikijs/types@2.2.0