shiki 2.4.1 → 2.4.2

package/dist/core-unwasm.d.mts

@@ -474,11 +474,15 @@ declare function createCssVariablesTheme(options?: CssVariablesThemeOptions): Th
  */
 declare function transformerDecorations(): ShikiTransformer;
 
+declare function resolveColorReplacements(theme: ThemeRegistrationAny | string, options?: TokenizeWithThemeOptions): Record<string, string | undefined>;
+declare function applyColorReplacements(color: string, replacements?: Record<string, string | undefined>): string;
+declare function applyColorReplacements(color?: string | undefined, replacements?: Record<string, string | undefined>): string | undefined;
+
 declare function toArray<T>(x: MaybeArray<T>): T[];
 /**
- * Split a string into lines, each line preserves the line ending.
+ * Normalize a getter to a promise.
  */
-declare function splitLines(code: string, preserveEnding?: boolean): [string, number][];
+declare function normalizeGetter<T>(p: MaybeGetter<T>): Promise<T>;
 /**
  * Check if the language is plaintext that is ignored by Shiki.
  *
@@ -503,31 +507,18 @@ declare function isNoneTheme(theme: string | ThemeInput | null | undefined): the
  * Hard-coded themes: `none`.
  */
 declare function isSpecialTheme(theme: string | ThemeInput | null | undefined): theme is SpecialTheme;
+
 /**
  * Utility to append class to a hast node
  *
  * If the `property.class` is a string, it will be splitted by space and converted to an array.
  */
 declare function addClassToHast(node: Element, className: string | string[]): Element;
+
 /**
- * Split a token into multiple tokens by given offsets.
- *
- * The offsets are relative to the token, and should be sorted.
- */
-declare function splitToken<T extends Pick<ThemedToken, 'content' | 'offset'>>(token: T, offsets: number[]): T[];
-/**
- * Split 2D tokens array by given breakpoints.
- */
-declare function splitTokens<T extends Pick<ThemedToken, 'content' | 'offset'>>(tokens: T[][], breakpoints: number[] | Set<number>): T[][];
-/**
- * Normalize a getter to a promise.
+ * Split a string into lines, each line preserves the line ending.
  */
-declare function normalizeGetter<T>(p: MaybeGetter<T>): Promise<T>;
-declare function resolveColorReplacements(theme: ThemeRegistrationAny | string, options?: TokenizeWithThemeOptions): Record<string, string | undefined>;
-declare function applyColorReplacements(color: string, replacements?: Record<string, string | undefined>): string;
-declare function applyColorReplacements(color?: string | undefined, replacements?: Record<string, string | undefined>): string | undefined;
-declare function getTokenStyleObject(token: TokenStyles): Record<string, string>;
-declare function stringifyTokenStyle(token: string | Record<string, string>): string;
+declare function splitLines(code: string, preserveEnding?: boolean): [string, number][];
 /**
  * Creates a converter between index and position in a code block.
  *
@@ -545,6 +536,20 @@ declare function createPositionConverter(code: string): {
  */
 declare function guessEmbeddedLanguages(code: string, _lang: string | undefined, highlighter?: HighlighterGeneric<any, any>): string[];
 
+/**
+ * Split a token into multiple tokens by given offsets.
+ *
+ * The offsets are relative to the token, and should be sorted.
+ */
+declare function splitToken<T extends Pick<ThemedToken, 'content' | 'offset'>>(token: T, offsets: number[]): T[];
+/**
+ * Split 2D tokens array by given breakpoints.
+ */
+declare function splitTokens<T extends Pick<ThemedToken, 'content' | 'offset'>>(tokens: T[][], breakpoints: number[] | Set<number>): T[][];
+declare function flatTokenVariants(merged: ThemedTokenWithVariants, variantsOrder: string[], cssVariablePrefix: string, defaultColor: string | boolean): ThemedToken;
+declare function getTokenStyleObject(token: TokenStyles): Record<string, string>;
+declare function stringifyTokenStyle(token: string | Record<string, string>): string;
+
 type DeprecationTarget = 3;
 /**
  * Enable runtime warning for deprecated APIs, for the future versions of Shiki.
@@ -559,4 +564,4 @@ declare function enableDeprecationWarnings(emitDeprecation?: DeprecationTarget |
  */
 declare function warnDeprecated(message: string, version?: DeprecationTarget): void;
 
-export { type CreateSingletonShorthandsOptions, type CssVariablesThemeOptions, FontStyle, type ShorthandsBundle, EncodedTokenMetadata as StackElementMetadata, addClassToHast, applyColorReplacements, codeToHast, codeToHtml, codeToTokens, codeToTokensBase, codeToTokensWithThemes, createCssVariablesTheme, createHighlighterCore, createHighlighterCoreSync, createJavaScriptRegexEngine, createOnigurumaEngine, createPositionConverter, createShikiInternal, createShikiInternalSync, createSingletonShorthands, createWasmOnigEngine, createdBundledHighlighter, defaultJavaScriptRegexConstructor, enableDeprecationWarnings, getHighlighterCore, getShikiInternal, getSingletonHighlighterCore, getTokenStyleObject, guessEmbeddedLanguages, toHtml as hastToHtml, isNoneTheme, isPlainLang, isSpecialLang, isSpecialTheme, loadWasm, makeSingletonHighlighter, makeSingletonHighlighterCore, normalizeGetter, normalizeTheme, resolveColorReplacements, splitLines, splitToken, splitTokens, stringifyTokenStyle, toArray, tokenizeAnsiWithTheme, tokenizeWithTheme, tokensToHast, transformerDecorations, warnDeprecated };
+export { type CreateSingletonShorthandsOptions, type CssVariablesThemeOptions, FontStyle, type ShorthandsBundle, EncodedTokenMetadata as StackElementMetadata, addClassToHast, applyColorReplacements, codeToHast, codeToHtml, codeToTokens, codeToTokensBase, codeToTokensWithThemes, createCssVariablesTheme, createHighlighterCore, createHighlighterCoreSync, createJavaScriptRegexEngine, createOnigurumaEngine, createPositionConverter, createShikiInternal, createShikiInternalSync, createSingletonShorthands, createWasmOnigEngine, createdBundledHighlighter, defaultJavaScriptRegexConstructor, enableDeprecationWarnings, flatTokenVariants, getHighlighterCore, getShikiInternal, getSingletonHighlighterCore, getTokenStyleObject, guessEmbeddedLanguages, toHtml as hastToHtml, isNoneTheme, isPlainLang, isSpecialLang, isSpecialTheme, loadWasm, makeSingletonHighlighter, makeSingletonHighlighterCore, normalizeGetter, normalizeTheme, resolveColorReplacements, splitLines, splitToken, splitTokens, stringifyTokenStyle, toArray, tokenizeAnsiWithTheme, tokenizeWithTheme, tokensToHast, transformerDecorations, warnDeprecated };

package/dist/core.d.mts

@@ -1,4 +1,4 @@
 export * from '@shikijs/core';
 import '@shikijs/engine-oniguruma/wasm-inlined';
-import '@shikijs/engine-javascript';
+import '@shikijs/engine-oniguruma';
 import '@shikijs/vscode-textmate';

package/dist/engine-javascript.d.mts

@@ -1 +1,88 @@
-export * from '@shikijs/engine-javascript';
+import { PatternScanner, RegexEngineString, RegexEngine } from '@shikijs/types';
+import { IOnigMatch } from '@shikijs/vscode-textmate';
+
+type ToRegExpOptions = {
+    accuracy?: "default" | "strict";
+    avoidSubclass?: boolean;
+    flags?: string;
+    global?: boolean;
+    hasIndices?: boolean;
+    lazyCompileLength?: number;
+    rules?: {
+        allowOrphanBackrefs?: boolean;
+        asciiWordBoundaries?: boolean;
+        captureGroup?: boolean;
+        recursionLimit?: number;
+        singleline?: boolean;
+    };
+    target?: "auto" | "ES2025" | "ES2024" | "ES2018";
+    verbose?: boolean;
+};
+
+interface JavaScriptRegexScannerOptions {
+    /**
+     * Whether to allow invalid regex patterns.
+     *
+     * @default false
+     */
+    forgiving?: boolean;
+    /**
+     * Cache for regex patterns.
+     */
+    cache?: Map<string, RegExp | Error> | null;
+    /**
+     * Custom pattern to RegExp constructor.
+     *
+     * By default `oniguruma-to-es` is used.
+     */
+    regexConstructor?: (pattern: string) => RegExp;
+}
+declare class JavaScriptScanner implements PatternScanner {
+    patterns: (string | RegExp)[];
+    options: JavaScriptRegexScannerOptions;
+    regexps: (RegExp | null)[];
+    constructor(patterns: (string | RegExp)[], options?: JavaScriptRegexScannerOptions);
+    findNextMatchSync(string: string | RegexEngineString, startPosition: number, _options: number): IOnigMatch | null;
+}
+
+interface JavaScriptRegexEngineOptions extends JavaScriptRegexScannerOptions {
+    /**
+     * The target ECMAScript version.
+     *
+     * Oniguruma-To-ES uses RegExp features from later versions of ECMAScript to add support for a
+     * few more grammars. If using target `ES2024` or later, the RegExp `v` flag is used which
+     * requires Node.js 20+ or Chrome 112+.
+     * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/unicodeSets
+     *
+     * For maximum compatibility, you can set it to `ES2018` which uses the RegExp `u` flag.
+     *
+     * Set to `auto` to automatically detect the latest version supported by the environment.
+     *
+     * @default 'auto'
+     */
+    target?: 'auto' | 'ES2025' | 'ES2024' | 'ES2018';
+}
+/**
+ * The default regex constructor for the JavaScript RegExp engine.
+ */
+declare function defaultJavaScriptRegexConstructor(pattern: string, options?: ToRegExpOptions): RegExp;
+/**
+ * Use the modern JavaScript RegExp engine to implement the OnigScanner.
+ *
+ * As Oniguruma supports some features that can't be emulated using native JavaScript regexes, some
+ * patterns are not supported. Errors will be thrown when parsing TextMate grammars with
+ * unsupported patterns, and when the grammar includes patterns that use invalid Oniguruma syntax.
+ * Set `forgiving` to `true` to ignore these errors and skip any unsupported or invalid patterns.
+ */
+declare function createJavaScriptRegexEngine(options?: JavaScriptRegexEngineOptions): RegexEngine;
+
+/**
+ * Raw JavaScript regex engine that only supports precompiled grammars.
+ *
+ * This further simplifies the engine by excluding the regex compilation step.
+ *
+ * Zero dependencies.
+ */
+declare function createJavaScriptRawEngine(): RegexEngine;
+
+export { type JavaScriptRegexEngineOptions, type JavaScriptRegexScannerOptions, JavaScriptScanner, createJavaScriptRawEngine, createJavaScriptRegexEngine, defaultJavaScriptRegexConstructor };

package/dist/engine-oniguruma.d.mts

@@ -1,87 +1 @@
-interface IOnigCaptureIndex {
-    start: number;
-    end: number;
-    length: number;
-}
-interface IOnigMatch {
-    index: number;
-    captureIndices: IOnigCaptureIndex[];
-}
-declare const enum FindOption {
-    None = 0,
-    /**
-     * equivalent of ONIG_OPTION_NOT_BEGIN_STRING: (str) isn't considered as begin of string (* fail \A)
-     */
-    NotBeginString = 1,
-    /**
-     * equivalent of ONIG_OPTION_NOT_END_STRING: (end) isn't considered as end of string (* fail \z, \Z)
-     */
-    NotEndString = 2,
-    /**
-     * equivalent of ONIG_OPTION_NOT_BEGIN_POSITION: (start) isn't considered as start position of search (* fail \G)
-     */
-    NotBeginPosition = 4,
-    /**
-     * used for debugging purposes.
-     */
-    DebugCall = 8
-}
-interface OnigScanner {
-    findNextMatchSync(string: string | OnigString, startPosition: number, options: OrMask<FindOption>): IOnigMatch | null;
-    dispose?(): void;
-}
-interface OnigString {
-    readonly content: string;
-    dispose?(): void;
-}
-
-/**
- * A union of given const enum values.
-*/
-type OrMask<T extends number> = number;
-
-type Awaitable<T> = T | Promise<T>;
-
-interface PatternScanner extends OnigScanner {
-}
-interface RegexEngineString extends OnigString {
-}
-/**
- * Engine for RegExp matching and scanning.
- */
-interface RegexEngine {
-    createScanner: (patterns: (string | RegExp)[]) => PatternScanner;
-    createString: (s: string) => RegexEngineString;
-}
-interface WebAssemblyInstantiator {
-    (importObject: Record<string, Record<string, WebAssembly.ImportValue>> | undefined): Promise<WebAssemblyInstance>;
-}
-type WebAssemblyInstance = WebAssembly.WebAssemblyInstantiatedSource | WebAssembly.Instance | WebAssembly.Instance['exports'];
-type OnigurumaLoadOptions = {
-    instantiator: WebAssemblyInstantiator;
-} | {
-    default: WebAssemblyInstantiator;
-} | {
-    data: ArrayBufferView | ArrayBuffer | Response;
-};
-type LoadWasmOptionsPlain = OnigurumaLoadOptions | WebAssemblyInstantiator | ArrayBufferView | ArrayBuffer | Response;
-type LoadWasmOptions = Awaitable<LoadWasmOptionsPlain> | (() => Awaitable<LoadWasmOptionsPlain>);
-
-declare function loadWasm(options: LoadWasmOptions): Promise<void>;
-
-/**
- * Set the default wasm loader for `loadWasm`.
- * @internal
- */
-declare function setDefaultWasmLoader(_loader: LoadWasmOptions): void;
-/**
- * @internal
- */
-declare function getDefaultWasmLoader(): LoadWasmOptions | undefined;
-declare function createOnigurumaEngine(options?: LoadWasmOptions | null): Promise<RegexEngine>;
-/**
- * @deprecated Use `createOnigurumaEngine` instead.
- */
-declare function createWasmOnigEngine(options?: LoadWasmOptions | null): Promise<RegexEngine>;
-
-export { createOnigurumaEngine, createWasmOnigEngine, getDefaultWasmLoader, loadWasm, setDefaultWasmLoader };
+export * from '@shikijs/engine-oniguruma';

package/dist/index.d.mts

@@ -1,7 +1,6 @@
 export { Highlighter, codeToHast, codeToHtml, codeToTokens, codeToTokensBase, codeToTokensWithThemes, createHighlighter, getHighlighter, getLastGrammarState, getSingletonHighlighter } from './bundle-full.mjs';
 export { BuiltinLanguage, BuiltinTheme } from './types.mjs';
 export { createJavaScriptRegexEngine, defaultJavaScriptRegexConstructor } from '@shikijs/engine-javascript';
-export { createOnigurumaEngine, loadWasm } from './engine-oniguruma.mjs';
 export { g as getWasmInlined } from './types/wasm-dynamic.mjs';
 export * from '@shikijs/core';
 export { BundledLanguage, bundledLanguages, bundledLanguagesAlias, bundledLanguagesBase, bundledLanguagesInfo } from './langs.mjs';
@@ -9,3 +8,77 @@ export { BundledTheme, bundledThemes, bundledThemesInfo } from './themes.mjs';
 import './types/index.d.mjs';
 import '@shikijs/types';
 import '@shikijs/core/types';
+
+interface IOnigCaptureIndex {
+    start: number;
+    end: number;
+    length: number;
+}
+interface IOnigMatch {
+    index: number;
+    captureIndices: IOnigCaptureIndex[];
+}
+declare const enum FindOption {
+    None = 0,
+    /**
+     * equivalent of ONIG_OPTION_NOT_BEGIN_STRING: (str) isn't considered as begin of string (* fail \A)
+     */
+    NotBeginString = 1,
+    /**
+     * equivalent of ONIG_OPTION_NOT_END_STRING: (end) isn't considered as end of string (* fail \z, \Z)
+     */
+    NotEndString = 2,
+    /**
+     * equivalent of ONIG_OPTION_NOT_BEGIN_POSITION: (start) isn't considered as start position of search (* fail \G)
+     */
+    NotBeginPosition = 4,
+    /**
+     * used for debugging purposes.
+     */
+    DebugCall = 8
+}
+interface OnigScanner {
+    findNextMatchSync(string: string | OnigString, startPosition: number, options: OrMask<FindOption>): IOnigMatch | null;
+    dispose?(): void;
+}
+interface OnigString {
+    readonly content: string;
+    dispose?(): void;
+}
+
+/**
+ * A union of given const enum values.
+*/
+type OrMask<T extends number> = number;
+
+type Awaitable<T> = T | Promise<T>;
+
+interface PatternScanner extends OnigScanner {
+}
+interface RegexEngineString extends OnigString {
+}
+/**
+ * Engine for RegExp matching and scanning.
+ */
+interface RegexEngine {
+    createScanner: (patterns: (string | RegExp)[]) => PatternScanner;
+    createString: (s: string) => RegexEngineString;
+}
+interface WebAssemblyInstantiator {
+    (importObject: Record<string, Record<string, WebAssembly.ImportValue>> | undefined): Promise<WebAssemblyInstance>;
+}
+type WebAssemblyInstance = WebAssembly.WebAssemblyInstantiatedSource | WebAssembly.Instance | WebAssembly.Instance['exports'];
+type OnigurumaLoadOptions = {
+    instantiator: WebAssemblyInstantiator;
+} | {
+    default: WebAssemblyInstantiator;
+} | {
+    data: ArrayBufferView | ArrayBuffer | Response;
+};
+type LoadWasmOptionsPlain = OnigurumaLoadOptions | WebAssemblyInstantiator | ArrayBufferView | ArrayBuffer | Response;
+type LoadWasmOptions = Awaitable<LoadWasmOptionsPlain> | (() => Awaitable<LoadWasmOptionsPlain>);
+
+declare function loadWasm(options: LoadWasmOptions): Promise<void>;
+declare function createOnigurumaEngine(options?: LoadWasmOptions | null): Promise<RegexEngine>;
+
+export { createOnigurumaEngine, loadWasm };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "shiki",
   "type": "module",
-  "version": "2.4.1",
+  "version": "2.4.2",
   "description": "A beautiful Syntax Highlighter.",
   "author": "Pine Wu <octref@gmail.com>; Anthony Fu <anthonyfu117@hotmail.com>",
   "license": "MIT",
@@ -119,12 +119,12 @@
   "dependencies": {
     "@shikijs/vscode-textmate": "^10.0.2",
     "@types/hast": "^3.0.4",
-    "@shikijs/core": "2.4.1",
-    "@shikijs/langs": "2.4.1",
-    "@shikijs/engine-oniguruma": "2.4.1",
-    "@shikijs/types": "2.4.1",
-    "@shikijs/themes": "2.4.1",
-    "@shikijs/engine-javascript": "2.4.1"
+    "@shikijs/engine-javascript": "2.4.2",
+    "@shikijs/core": "2.4.2",
+    "@shikijs/engine-oniguruma": "2.4.2",
+    "@shikijs/themes": "2.4.2",
+    "@shikijs/langs": "2.4.2",
+    "@shikijs/types": "2.4.2"
   },
   "devDependencies": {
     "rollup-plugin-copy": "^3.5.0",