@shikijs/core 1.14.1 → 1.15.1

package/dist/{chunk-index.d.mts → chunk-engines.d.mts}

@@ -1,3 +1,4 @@
+type Awaitable<T> = T | Promise<T>;
 interface WebAssemblyInstantiator {
     (importObject: Record<string, Record<string, WebAssembly.ImportValue>> | undefined): Promise<WebAssemblyInstance>;
 }
@@ -9,9 +10,17 @@ type OnigurumaLoadOptions = {
 } | {
     data: ArrayBufferView | ArrayBuffer | Response;
 };
-type Awaitable<T> = T | Promise<T>;
 type LoadWasmOptionsPlain = OnigurumaLoadOptions | WebAssemblyInstantiator | ArrayBufferView | ArrayBuffer | Response;
 type LoadWasmOptions = Awaitable<LoadWasmOptionsPlain> | (() => Awaitable<LoadWasmOptionsPlain>);
-declare function loadWasm(options: LoadWasmOptions): Promise<void>;
+interface JavaScriptRegexEngineOptions {
+    /**
+     * Whether to allow invalid regex patterns.
+     */
+    forgiving?: boolean;
+    /**
+     * Cache for regex patterns.
+     */
+    cache?: Map<string, RegExp | Error>;
+}
 
-export { type LoadWasmOptions as L, type WebAssemblyInstantiator as W, loadWasm as l };
+export type { JavaScriptRegexEngineOptions as J, LoadWasmOptions as L, WebAssemblyInstantiator as W, WebAssemblyInstance as a };

package/dist/chunk-tokens.d.mts

@@ -1,5 +1,5 @@
-import { L as LoadWasmOptions } from './chunk-index.mjs';
 import { Root, Element } from 'hast';
+import { L as LoadWasmOptions } from './chunk-engines.mjs';
 
 /**
  * A union of given const enum values.
@@ -222,7 +222,7 @@ interface ILocatable {
     readonly $vscodeTextmateLocation?: ILocation;
 }
 
-declare const enum StandardTokenType {
+declare const enum StandardTokenType$1 {
     Other = 0,
     Comment = 1,
     String = 2,
@@ -249,7 +249,7 @@ interface IEmbeddedLanguagesMap {
  * A map from selectors to token types.
  */
 interface ITokenTypeMap {
-    [selector: string]: StandardTokenType;
+    [selector: string]: StandardTokenType$1;
 }
 interface IGrammarConfiguration {
     embeddedLanguages?: IEmbeddedLanguagesMap;
@@ -364,6 +364,42 @@ interface StateStack {
 }
 declare const INITIAL: StateStack;
 
+declare const enum TemporaryStandardTokenType {
+    Other = 0,
+    Comment = 1,
+    String = 2,
+    RegEx = 4,
+    MetaEmbedded = 8
+}
+declare const enum StandardTokenType {
+    Other = 0,
+    Comment = 1,
+    String = 2,
+    RegEx = 4
+}
+declare class StackElementMetadata {
+    static toBinaryStr(metadata: number): string;
+    static getLanguageId(metadata: number): number;
+    static getTokenType(metadata: number): number;
+    static getFontStyle(metadata: number): number;
+    static getForeground(metadata: number): number;
+    static getBackground(metadata: number): number;
+    static containsBalancedBrackets(metadata: number): boolean;
+    static set(metadata: number, languageId: number, tokenType: TemporaryStandardTokenType, fontStyle: FontStyle, foreground: number, background: number): number;
+}
+
+interface PatternScanner extends OnigScanner {
+}
+interface RegexEngineString extends OnigString {
+}
+/**
+ * Engine for RegExp matching and scanning.
+ */
+interface RegexEngine {
+    createScanner: (patterns: string[]) => PatternScanner;
+    createString: (s: string) => RegexEngineString;
+}
+
 type Awaitable<T> = T | Promise<T>;
 type MaybeGetter<T> = Awaitable<MaybeModule<T>> | (() => Awaitable<MaybeModule<T>>);
 type MaybeModule<T> = T | {
@@ -688,8 +724,12 @@ interface HighlighterCoreOptions {
      * @default true
      */
     warnings?: boolean;
+    /**
+     * Custom RegExp engine.
+     */
+    engine?: RegexEngine | Promise<RegexEngine>;
 }
-interface BundledHighlighterOptions<L extends string, T extends string> {
+interface BundledHighlighterOptions<L extends string, T extends string> extends Pick<HighlighterCoreOptions, 'warnings' | 'engine'> {
     /**
      * Theme registation
      *
@@ -1019,4 +1059,4 @@ declare enum FontStyle {
     Underline = 4
 }
 
-export { type ThemedTokenScopeExplanation as $, type AnsiLanguage as A, type BundledHighlighterOptions as B, type CodeToHastOptions as C, type ResolveBundleKey as D, type LanguageRegistration as E, FontStyle as F, GrammarState as G, type HighlighterCoreOptions as H, INITIAL as I, type BundledLanguageInfo as J, type DynamicImportLanguageRegistration as K, type LanguageInput as L, type MaybeArray as M, type CodeOptionsSingleTheme as N, type CodeOptionsMultipleThemes as O, type PlainTextLanguage as P, type CodeOptionsThemes as Q, Registry as R, type StateStack as S, Theme as T, type CodeToHastOptionsCommon as U, type CodeOptionsMeta as V, type CodeToHastRenderOptionsCommon as W, type ThemeRegistrationRaw as X, type ThemeRegistration as Y, type DynamicImportThemeRegistration as Z, type BundledThemeInfo as _, type IRawTheme as a, type ThemedTokenExplanation as a0, type TokenBase as a1, type TransformerOptions as a2, type ShikiTransformerContextMeta as a3, type ShikiTransformerContext as a4, type Awaitable as a5, type MaybeGetter as a6, type MaybeModule as a7, type StringLiteralUnion as a8, type DecorationOptions as a9, type DecorationItem as aa, type ResolvedDecorationItem as ab, type DecorationTransformType as ac, type Offset as ad, type OffsetOrPosition as ae, type ResolvedPosition as af, type IRawGrammar as b, type IGrammar as c, type IGrammarConfiguration as d, type IOnigLib as e, type RegistryOptions as f, type IRawThemeSetting as g, type ThemeInput as h, type CodeToTokensOptions as i, type TokensResult as j, type RequireKeys as k, type CodeToTokensBaseOptions as l, type ThemedToken as m, type CodeToTokensWithThemesOptions as n, type ThemedTokenWithVariants as o, type SpecialLanguage as p, type SpecialTheme as q, type ThemeRegistrationAny as r, type TokenizeWithThemeOptions as s, type TokenStyles as t, type Position as u, type ThemeRegistrationResolved as v, type ShikiTransformerContextCommon as w, type CodeToHastRenderOptions as x, type ShikiTransformerContextSource as y, type ShikiTransformer as z };
+export { type Awaitable as $, type AnsiLanguage as A, type BundledHighlighterOptions as B, type CodeToHastOptions as C, type DynamicImportLanguageRegistration as D, type IRawGrammar as E, type IRawTheme as F, GrammarState as G, type HighlighterCoreOptions as H, type IGrammar as I, type IRawThemeSetting as J, type ThemeRegistrationRaw as K, type LanguageInput as L, type MaybeArray as M, type ThemeRegistration as N, type DynamicImportThemeRegistration as O, type PlainTextLanguage as P, type BundledThemeInfo as Q, type RequireKeys as R, type SpecialLanguage as S, type ThemeInput as T, type ThemedTokenScopeExplanation as U, type ThemedTokenExplanation as V, type TokenBase as W, FontStyle as X, type TransformerOptions as Y, type ShikiTransformerContextMeta as Z, type ShikiTransformerContext as _, type CodeToTokensOptions as a, type MaybeGetter as a0, type MaybeModule as a1, type StringLiteralUnion as a2, type DecorationOptions as a3, type DecorationItem as a4, type ResolvedDecorationItem as a5, type DecorationTransformType as a6, type Offset as a7, type OffsetOrPosition as a8, type ResolvedPosition as a9, type PatternScanner as aa, type RegexEngineString as ab, Registry as ac, INITIAL as ad, type StateStack as ae, Theme as af, type IGrammarConfiguration as ag, type RegistryOptions as ah, TemporaryStandardTokenType as ai, StandardTokenType as aj, StackElementMetadata as ak, type TokensResult as b, type CodeToTokensBaseOptions as c, type ThemedToken as d, type CodeToTokensWithThemesOptions as e, type ThemedTokenWithVariants as f, type SpecialTheme as g, type ThemeRegistrationAny as h, type TokenizeWithThemeOptions as i, type TokenStyles as j, type Position as k, type RegexEngine as l, type ThemeRegistrationResolved as m, type ShikiTransformerContextCommon as n, type CodeToHastRenderOptions as o, type ShikiTransformerContextSource as p, type ShikiTransformer as q, type ResolveBundleKey as r, type LanguageRegistration as s, type BundledLanguageInfo as t, type CodeOptionsSingleTheme as u, type CodeOptionsMultipleThemes as v, type CodeOptionsThemes as w, type CodeToHastOptionsCommon as x, type CodeOptionsMeta as y, type CodeToHastRenderOptionsCommon as z };

package/dist/index.d.mts

@@ -1,11 +1,10 @@
 import { HighlighterCore, HighlighterGeneric, ShikiInternal } from './types.mjs';
 export { Grammar } from './types.mjs';
-import { H as HighlighterCoreOptions, B as BundledHighlighterOptions, L as LanguageInput, h as ThemeInput, C as CodeToHastOptions, i as CodeToTokensOptions, j as TokensResult, k as RequireKeys, l as CodeToTokensBaseOptions, m as ThemedToken, n as CodeToTokensWithThemesOptions, o as ThemedTokenWithVariants, G as GrammarState, M as MaybeArray, P as PlainTextLanguage, p as SpecialLanguage, q as SpecialTheme, r as ThemeRegistrationAny, s as TokenizeWithThemeOptions, t as TokenStyles, u as Position, c as IGrammar, v as ThemeRegistrationResolved, w as ShikiTransformerContextCommon, x as CodeToHastRenderOptions, y as ShikiTransformerContextSource, z as ShikiTransformer } from './chunk-tokens.mjs';
-export { A as AnsiLanguage, a5 as Awaitable, J as BundledLanguageInfo, _ as BundledThemeInfo, V as CodeOptionsMeta, O as CodeOptionsMultipleThemes, N as CodeOptionsSingleTheme, Q as CodeOptionsThemes, U as CodeToHastOptionsCommon, W as CodeToHastRenderOptionsCommon, aa as DecorationItem, a9 as DecorationOptions, ac as DecorationTransformType, K as DynamicImportLanguageRegistration, Z as DynamicImportThemeRegistration, F as FontStyle, E as LanguageRegistration, a6 as MaybeGetter, a7 as MaybeModule, ad as Offset, ae as OffsetOrPosition, b as RawGrammar, a as RawTheme, g as RawThemeSetting, D as ResolveBundleKey, ab as ResolvedDecorationItem, af as ResolvedPosition, a4 as ShikiTransformerContext, a3 as ShikiTransformerContextMeta, a8 as StringLiteralUnion, Y as ThemeRegistration, X as ThemeRegistrationRaw, a0 as ThemedTokenExplanation, $ as ThemedTokenScopeExplanation, a1 as TokenBase, a2 as TransformerOptions } from './chunk-tokens.mjs';
-import * as hast from 'hast';
-import { Root, Element } from 'hast';
-import { L as LoadWasmOptions } from './chunk-index.mjs';
-export { W as WebAssemblyInstantiator, l as loadWasm } from './chunk-index.mjs';
+import { H as HighlighterCoreOptions, B as BundledHighlighterOptions, L as LanguageInput, T as ThemeInput, C as CodeToHastOptions, a as CodeToTokensOptions, b as TokensResult, R as RequireKeys, c as CodeToTokensBaseOptions, d as ThemedToken, e as CodeToTokensWithThemesOptions, f as ThemedTokenWithVariants, G as GrammarState, M as MaybeArray, P as PlainTextLanguage, S as SpecialLanguage, g as SpecialTheme, h as ThemeRegistrationAny, i as TokenizeWithThemeOptions, j as TokenStyles, k as Position, l as RegexEngine, I as IGrammar, m as ThemeRegistrationResolved, n as ShikiTransformerContextCommon, o as CodeToHastRenderOptions, p as ShikiTransformerContextSource, q as ShikiTransformer } from './chunk-tokens.mjs';
+export { A as AnsiLanguage, $ as Awaitable, t as BundledLanguageInfo, Q as BundledThemeInfo, y as CodeOptionsMeta, v as CodeOptionsMultipleThemes, u as CodeOptionsSingleTheme, w as CodeOptionsThemes, x as CodeToHastOptionsCommon, z as CodeToHastRenderOptionsCommon, a4 as DecorationItem, a3 as DecorationOptions, a6 as DecorationTransformType, D as DynamicImportLanguageRegistration, O as DynamicImportThemeRegistration, X as FontStyle, s as LanguageRegistration, a0 as MaybeGetter, a1 as MaybeModule, a7 as Offset, a8 as OffsetOrPosition, E as RawGrammar, F as RawTheme, J as RawThemeSetting, r as ResolveBundleKey, a5 as ResolvedDecorationItem, a9 as ResolvedPosition, _ as ShikiTransformerContext, Z as ShikiTransformerContextMeta, a2 as StringLiteralUnion, N as ThemeRegistration, K as ThemeRegistrationRaw, V as ThemedTokenExplanation, U as ThemedTokenScopeExplanation, W as TokenBase, Y as TransformerOptions } from './chunk-tokens.mjs';
+import { Root, Element, RootContent, Nodes } from 'hast';
+import { L as LoadWasmOptions, J as JavaScriptRegexEngineOptions } from './chunk-engines.mjs';
+export { a as WebAssemblyInstance, W as WebAssemblyInstantiator } from './chunk-engines.mjs';
 
 /**
  * Create a Shiki core highlighter instance, with no languages or themes bundled.
@@ -142,6 +141,21 @@ declare function createPositionConverter(code: string): {
     posToIndex: (line: number, character: number) => number;
 };
 
+declare function loadWasm(options: LoadWasmOptions): Promise<void>;
+
+declare function createWasmOnigEngine(options?: LoadWasmOptions | null): Promise<RegexEngine>;
+
+/**
+ * Use the modern JavaScript RegExp engine to implement the OnigScanner.
+ *
+ * As Oniguruma regex is more powerful than JavaScript regex, some patterns may not be supported.
+ * Errors will be thrown when parsing TextMate grammars with unsupported patterns.
+ * Set `forgiving` to `true` to ignore these errors and skip the unsupported patterns.
+ *
+ * @experimental
+ */
+declare function createJavaScriptRegexEngine(options?: JavaScriptRegexEngineOptions): RegexEngine;
+
 /**
  * Set the default wasm loader for `loadWasm`.
  * @internal
@@ -226,10 +240,7 @@ type Options$1 = Options$2
  *   Serialized HTML.
  */
 declare function toHtml(tree: Array<RootContent> | Nodes, options?: Options | null | undefined): string;
-type Nodes = hast.Nodes;
-type RootContent = hast.RootContent;
-type StringifyEntitiesOptions = Options$1;
-type CharacterReferences = Omit<StringifyEntitiesOptions, 'attribute' | 'escapeOnly' | 'subset'>;
+type CharacterReferences = Omit<Options$1, "attribute" | "escapeOnly" | "subset">;
 /**
  * Configuration.
  */
@@ -318,14 +329,14 @@ type Options = {
      * Not used in the SVG space.
      */
     preferUnquoted?: boolean | null | undefined;
-    /**
-     * Preferred quote to use (default: `'"'`).
-     */
-    quote?: Quote | null | undefined;
     /**
      * Use the other quote if that results in less bytes (default: `false`).
      */
     quoteSmart?: boolean | null | undefined;
+    /**
+     * Preferred quote to use (default: `'"'`).
+     */
+    quote?: Quote | null | undefined;
     /**
      * When an `<svg>` element is found in the HTML space, this package already
      * automatically switches to and from the SVG space when entering and exiting
@@ -390,11 +401,11 @@ type Options = {
 /**
  * HTML quotes for attribute values.
  */
-type Quote = '"' | "'";
+type Quote = "\"" | "'";
 /**
  * Namespace.
  */
-type Space = 'html' | 'svg';
+type Space = "html" | "svg";
 
 /**
  * Get highlighted code in HTML.
@@ -420,4 +431,4 @@ declare class ShikiError extends Error {
     constructor(message: string);
 }
 
-export { BundledHighlighterOptions, CodeToHastOptions, CodeToHastRenderOptions, CodeToTokensBaseOptions, CodeToTokensOptions, CodeToTokensWithThemesOptions, type CreateHighlighterFactory, GrammarState, HighlighterCore, HighlighterCoreOptions, HighlighterGeneric, LanguageInput, MaybeArray, PlainTextLanguage, Position, RequireKeys, ShikiError, ShikiInternal, ShikiTransformer, ShikiTransformerContextCommon, ShikiTransformerContextSource, type ShorthandsBundle, SpecialLanguage, SpecialTheme, ThemeInput, ThemeRegistrationAny, ThemeRegistrationResolved, ThemedToken, ThemedTokenWithVariants, TokenStyles, TokenizeWithThemeOptions, TokensResult, addClassToHast, applyColorReplacements, codeToHast, codeToHtml, codeToTokens, codeToTokensBase, codeToTokensWithThemes, createHighlighterCore, createPositionConverter, createShikiInternal, createSingletonShorthands, createdBundledHighlighter, getHighlighterCore, getShikiInternal, getSingletonHighlighterCore, getTokenStyleObject, toHtml as hastToHtml, isNoneTheme, isPlainLang, isSpecialLang, isSpecialTheme, makeSingletonHighlighter, makeSingletonHighlighterCore, normalizeTheme, resolveColorReplacements, setDefaultWasmLoader, splitLines, splitToken, splitTokens, stringifyTokenStyle, toArray, tokenizeAnsiWithTheme, tokenizeWithTheme, tokensToHast, transformerDecorations };
+export { BundledHighlighterOptions, CodeToHastOptions, CodeToHastRenderOptions, CodeToTokensBaseOptions, CodeToTokensOptions, CodeToTokensWithThemesOptions, type CreateHighlighterFactory, GrammarState, HighlighterCore, HighlighterCoreOptions, HighlighterGeneric, LanguageInput, LoadWasmOptions, MaybeArray, PlainTextLanguage, Position, RequireKeys, ShikiError, ShikiInternal, ShikiTransformer, ShikiTransformerContextCommon, ShikiTransformerContextSource, type ShorthandsBundle, SpecialLanguage, SpecialTheme, ThemeInput, ThemeRegistrationAny, ThemeRegistrationResolved, ThemedToken, ThemedTokenWithVariants, TokenStyles, TokenizeWithThemeOptions, TokensResult, addClassToHast, applyColorReplacements, codeToHast, codeToHtml, codeToTokens, codeToTokensBase, codeToTokensWithThemes, createHighlighterCore, createJavaScriptRegexEngine, createPositionConverter, createShikiInternal, createSingletonShorthands, createWasmOnigEngine, createdBundledHighlighter, getHighlighterCore, getShikiInternal, getSingletonHighlighterCore, getTokenStyleObject, toHtml as hastToHtml, isNoneTheme, isPlainLang, isSpecialLang, isSpecialTheme, loadWasm, makeSingletonHighlighter, makeSingletonHighlighterCore, normalizeTheme, resolveColorReplacements, setDefaultWasmLoader, splitLines, splitToken, splitTokens, stringifyTokenStyle, toArray, tokenizeAnsiWithTheme, tokenizeWithTheme, tokensToHast, transformerDecorations };