@shikijs/core 1.16.1 → 1.16.3

package/dist/chunk-engines.d.mts

@@ -49,6 +49,12 @@ interface JavaScriptRegexEngineOptions {
      * Cache for regex patterns.
      */
     cache?: Map<string, RegExp | Error>;
+    /**
+     * Custom pattern to RegExp constructor.
+     *
+     * By default `oniguruma-to-js` is used.
+     */
+    regexConstructor?: (pattern: string) => RegExp;
 }
 
-export type { Awaitable as A, JavaScriptRegexEngineOptions as J, LoadWasmOptions as L, MaybeArray as M, OnigurumaLoadOptions as O, PatternScanner as P, RequireKeys as R, StringLiteralUnion as S, WebAssemblyInstantiator as W, RegexEngine as a, MaybeGetter as b, MaybeModule as c, RegexEngineString as d, WebAssemblyInstance as e, LoadWasmOptionsPlain as f };
+export type { Awaitable as A, JavaScriptRegexEngineOptions as J, LoadWasmOptions as L, MaybeArray as M, OnigurumaLoadOptions as O, PatternScanner as P, RequireKeys as R, StringLiteralUnion as S, WebAssemblyInstantiator as W, RegexEngine as a, MaybeGetter as b, RegexEngineString as c, WebAssemblyInstance as d, LoadWasmOptionsPlain as e, MaybeModule as f };

package/dist/index.d.mts

@@ -1,34 +1,11 @@
-import { HighlighterCoreOptions, HighlighterCore, BundledHighlighterOptions, HighlighterGeneric, CreatedBundledHighlighterOptions, LanguageInput, ThemeInput, CodeToHastOptions, CodeToTokensOptions, TokensResult, CodeToTokensBaseOptions, ThemedToken, CodeToTokensWithThemesOptions, ThemedTokenWithVariants, GrammarState, ShikiInternal, ThemeRegistrationAny, ThemeRegistrationResolved, TokenizeWithThemeOptions, ShikiTransformerContextCommon, CodeToHastRenderOptions, ShikiTransformerContextSource, PlainTextLanguage, SpecialLanguage, SpecialTheme, TokenStyles, Position, ShikiTransformer } from './types.mjs';
-export { AnsiLanguage, BundledLanguageInfo, BundledThemeInfo, CodeOptionsMeta, CodeOptionsMultipleThemes, CodeOptionsSingleTheme, CodeOptionsThemes, CodeToHastOptionsCommon, CodeToHastRenderOptionsCommon, DecorationItem, DecorationOptions, DecorationTransformType, DynamicImportLanguageRegistration, DynamicImportThemeRegistration, FontStyle, Grammar, LanguageRegistration, Offset, OffsetOrPosition, ResolveBundleKey, ResolvedDecorationItem, ResolvedPosition, ShikiTransformerContext, ShikiTransformerContextMeta, ThemeRegistration, ThemeRegistrationRaw, ThemedTokenExplanation, ThemedTokenScopeExplanation, TokenBase, TransformerOptions } from './types.mjs';
-import { R as RequireKeys, L as LoadWasmOptions, a as RegexEngine, J as JavaScriptRegexEngineOptions, M as MaybeArray, b as MaybeGetter } from './chunk-engines.mjs';
-export { A as Awaitable, f as LoadWasmOptionsPlain, c as MaybeModule, O as OnigurumaLoadOptions, P as PatternScanner, d as RegexEngineString, S as StringLiteralUnion, e as WebAssemblyInstance, W as WebAssemblyInstantiator } from './chunk-engines.mjs';
 import { Root, RootContent, Nodes, Element } from 'hast';
+import { R as RequireKeys, L as LoadWasmOptions, J as JavaScriptRegexEngineOptions, a as RegexEngine, M as MaybeArray, b as MaybeGetter } from './chunk-engines.mjs';
+export { A as Awaitable, e as LoadWasmOptionsPlain, f as MaybeModule, O as OnigurumaLoadOptions, P as PatternScanner, c as RegexEngineString, S as StringLiteralUnion, d as WebAssemblyInstance, W as WebAssemblyInstantiator } from './chunk-engines.mjs';
+import { BundledHighlighterOptions, HighlighterGeneric, CreatedBundledHighlighterOptions, LanguageInput, ThemeInput, HighlighterCoreOptions, CodeToHastOptions, CodeToTokensOptions, TokensResult, CodeToTokensBaseOptions, ThemedToken, CodeToTokensWithThemesOptions, ThemedTokenWithVariants, GrammarState, HighlighterCore, ShikiInternal, ShikiTransformerContextCommon, CodeToHastRenderOptions, ShikiTransformerContextSource, ThemeRegistrationResolved, TokenizeWithThemeOptions, ThemeRegistrationAny, ShikiTransformer, PlainTextLanguage, SpecialLanguage, SpecialTheme, TokenStyles, Position } from './types.mjs';
+export { AnsiLanguage, BundledLanguageInfo, BundledThemeInfo, CodeOptionsMeta, CodeOptionsMultipleThemes, CodeOptionsSingleTheme, CodeOptionsThemes, CodeToHastOptionsCommon, CodeToHastRenderOptionsCommon, DecorationItem, DecorationOptions, DecorationTransformType, DynamicImportLanguageRegistration, DynamicImportThemeRegistration, FontStyle, Grammar, LanguageRegistration, Offset, OffsetOrPosition, ResolveBundleKey, ResolvedDecorationItem, ResolvedPosition, ShikiTransformerContext, ShikiTransformerContextMeta, ThemeRegistration, ThemeRegistrationRaw, ThemedTokenExplanation, ThemedTokenScopeExplanation, TokenBase, TransformerOptions } from './types.mjs';
 import { IGrammar } from '@shikijs/vscode-textmate';
 export { IRawGrammar as RawGrammar, IRawTheme as RawTheme, IRawThemeSetting as RawThemeSetting, EncodedTokenMetadata as StackElementMetadata } from '@shikijs/vscode-textmate';
 
-/**
- * Create a Shiki core highlighter instance, with no languages or themes bundled.
- * Wasm and each language and theme must be loaded manually.
- *
- * @see http://shiki.style/guide/bundles#fine-grained-bundle
- */
-declare function createHighlighterCore(options?: HighlighterCoreOptions): Promise<HighlighterCore>;
-/**
- * Create a Shiki core highlighter instance, with no languages or themes bundled.
- * Wasm and each language and theme must be loaded manually.
- *
- * Synchronous version of `createHighlighterCore`, which requires to provide the engine and all themes and languages upfront.
- *
- * @see http://shiki.style/guide/bundles#fine-grained-bundle
- */
-declare function createHighlighterCoreSync(options?: HighlighterCoreOptions<true>): HighlighterCore;
-declare function makeSingletonHighlighterCore(createHighlighter: typeof createHighlighterCore): (options?: Partial<HighlighterCoreOptions>) => Promise<HighlighterCore>;
-declare const getSingletonHighlighterCore: (options?: Partial<HighlighterCoreOptions>) => Promise<HighlighterCore>;
-/**
- * @deprecated Use `createHighlighterCore` or `getSingletonHighlighterCore` instead.
- */
-declare function getHighlighterCore(options?: HighlighterCoreOptions): Promise<HighlighterCore>;
-
 type CreateHighlighterFactory<L extends string, T extends string> = (options: BundledHighlighterOptions<L, T>) => Promise<HighlighterGeneric<L, T>>;
 /**
  * Create a `createHighlighter` function with bundled themes, languages, and engine.
@@ -107,11 +84,27 @@ declare function makeSingletonHighlighter<L extends string, T extends string>(cr
 declare function createSingletonShorthands<L extends string, T extends string>(createHighlighter: CreateHighlighterFactory<L, T>): ShorthandsBundle<L, T>;
 
 /**
- * Get the minimal shiki context for rendering.
+ * Create a Shiki core highlighter instance, with no languages or themes bundled.
+ * Wasm and each language and theme must be loaded manually.
  *
- * Synchronous version of `createShikiInternal`, which requires to provide the engine and all themes and languages upfront.
+ * @see http://shiki.style/guide/bundles#fine-grained-bundle
  */
-declare function createShikiInternalSync(options: HighlighterCoreOptions<true>): ShikiInternal;
+declare function createHighlighterCore(options?: HighlighterCoreOptions): Promise<HighlighterCore>;
+/**
+ * Create a Shiki core highlighter instance, with no languages or themes bundled.
+ * Wasm and each language and theme must be loaded manually.
+ *
+ * Synchronous version of `createHighlighterCore`, which requires to provide the engine and all themes and languages upfront.
+ *
+ * @see http://shiki.style/guide/bundles#fine-grained-bundle
+ */
+declare function createHighlighterCoreSync(options?: HighlighterCoreOptions<true>): HighlighterCore;
+declare function makeSingletonHighlighterCore(createHighlighter: typeof createHighlighterCore): (options?: Partial<HighlighterCoreOptions>) => Promise<HighlighterCore>;
+declare const getSingletonHighlighterCore: (options?: Partial<HighlighterCoreOptions>) => Promise<HighlighterCore>;
+/**
+ * @deprecated Use `createHighlighterCore` or `getSingletonHighlighterCore` instead.
+ */
+declare function getHighlighterCore(options?: HighlighterCoreOptions): Promise<HighlighterCore>;
 
 /**
  * Set the default wasm loader for `loadWasm`.
@@ -127,10 +120,17 @@ declare function createShikiInternal(options?: HighlighterCoreOptions): Promise<
  */
 declare function getShikiInternal(options?: HighlighterCoreOptions): Promise<ShikiInternal>;
 
-declare function loadWasm(options: LoadWasmOptions): Promise<void>;
-
-declare function createWasmOnigEngine(options?: LoadWasmOptions | null): Promise<RegexEngine>;
+/**
+ * Get the minimal shiki context for rendering.
+ *
+ * Synchronous version of `createShikiInternal`, which requires to provide the engine and all themes and languages upfront.
+ */
+declare function createShikiInternalSync(options: HighlighterCoreOptions<true>): ShikiInternal;
 
+/**
+ * The default RegExp constructor for JavaScript regex engine.
+ */
+declare function defaultJavaScriptRegexConstructor(pattern: string): RegExp;
 /**
  * Use the modern JavaScript RegExp engine to implement the OnigScanner.
  *
@@ -142,25 +142,13 @@ declare function createWasmOnigEngine(options?: LoadWasmOptions | null): Promise
  */
 declare function createJavaScriptRegexEngine(options?: JavaScriptRegexEngineOptions): RegexEngine;
 
-/**
- * Normalize a textmate theme to shiki theme
- */
-declare function normalizeTheme(rawTheme: ThemeRegistrationAny): ThemeRegistrationResolved;
-
-/**
- * Code to tokens, with a simple theme.
- */
-declare function codeToTokensBase(internal: ShikiInternal, code: string, options?: CodeToTokensBaseOptions): ThemedToken[][];
-declare function tokenizeWithTheme(code: string, grammar: IGrammar, theme: ThemeRegistrationResolved, colorMap: string[], options: TokenizeWithThemeOptions): ThemedToken[][];
+declare function loadWasm(options: LoadWasmOptions): Promise<void>;
 
-/**
- * High-level code-to-tokens API.
- *
- * It will use `codeToTokensWithThemes` or `codeToTokensBase` based on the options.
- */
-declare function codeToTokens(internal: ShikiInternal, code: string, options: CodeToTokensOptions): TokensResult;
+declare function createWasmOnigEngine(options?: LoadWasmOptions | null): Promise<RegexEngine>;
 
-declare function tokenizeAnsiWithTheme(theme: ThemeRegistrationResolved, fileContents: string, options?: TokenizeWithThemeOptions): ThemedToken[][];
+declare class ShikiError extends Error {
+    constructor(message: string);
+}
 
 declare function codeToHast(internal: ShikiInternal, code: string, options: CodeToHastOptions, transformerContext?: ShikiTransformerContextCommon): Root;
 declare function tokensToHast(tokens: ThemedToken[][], options: CodeToHastRenderOptions, transformerContext: ShikiTransformerContextSource): Root;
@@ -389,11 +377,36 @@ type Space = "html" | "svg";
  */
 declare function codeToHtml(internal: ShikiInternal, code: string, options: CodeToHastOptions): string;
 
+/**
+ * High-level code-to-tokens API.
+ *
+ * It will use `codeToTokensWithThemes` or `codeToTokensBase` based on the options.
+ */
+declare function codeToTokens(internal: ShikiInternal, code: string, options: CodeToTokensOptions): TokensResult;
+
+declare function tokenizeAnsiWithTheme(theme: ThemeRegistrationResolved, fileContents: string, options?: TokenizeWithThemeOptions): ThemedToken[][];
+
+/**
+ * Code to tokens, with a simple theme.
+ */
+declare function codeToTokensBase(internal: ShikiInternal, code: string, options?: CodeToTokensBaseOptions): ThemedToken[][];
+declare function tokenizeWithTheme(code: string, grammar: IGrammar, theme: ThemeRegistrationResolved, colorMap: string[], options: TokenizeWithThemeOptions): ThemedToken[][];
+
 /**
  * Get tokens with multiple themes
  */
 declare function codeToTokensWithThemes(internal: ShikiInternal, code: string, options: CodeToTokensWithThemesOptions): ThemedTokenWithVariants[][];
 
+/**
+ * Normalize a textmate theme to shiki theme
+ */
+declare function normalizeTheme(rawTheme: ThemeRegistrationAny): ThemeRegistrationResolved;
+
+/**
+ * A built-in transformer to add decorations to the highlighted code.
+ */
+declare function transformerDecorations(): ShikiTransformer;
+
 declare function toArray<T>(x: MaybeArray<T>): T[];
 /**
  * Split a string into lines, each line preserves the line ending.
@@ -461,13 +474,4 @@ declare function createPositionConverter(code: string): {
     posToIndex: (line: number, character: number) => number;
 };
 
-/**
- * A built-in transformer to add decorations to the highlighted code.
- */
-declare function transformerDecorations(): ShikiTransformer;
-
-declare class ShikiError extends Error {
-    constructor(message: string);
-}
-
-export { BundledHighlighterOptions, CodeToHastOptions, CodeToHastRenderOptions, CodeToTokensBaseOptions, CodeToTokensOptions, CodeToTokensWithThemesOptions, type CreateHighlighterFactory, CreatedBundledHighlighterOptions, GrammarState, HighlighterCore, HighlighterCoreOptions, HighlighterGeneric, JavaScriptRegexEngineOptions, LanguageInput, LoadWasmOptions, MaybeArray, MaybeGetter, PlainTextLanguage, Position, RegexEngine, 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, createHighlighterCoreSync, createJavaScriptRegexEngine, createPositionConverter, createShikiInternal, createShikiInternalSync, createSingletonShorthands, createWasmOnigEngine, createdBundledHighlighter, getHighlighterCore, getShikiInternal, getSingletonHighlighterCore, getTokenStyleObject, toHtml as hastToHtml, isNoneTheme, isPlainLang, isSpecialLang, isSpecialTheme, loadWasm, makeSingletonHighlighter, makeSingletonHighlighterCore, normalizeGetter, normalizeTheme, resolveColorReplacements, setDefaultWasmLoader, splitLines, splitToken, splitTokens, stringifyTokenStyle, toArray, tokenizeAnsiWithTheme, tokenizeWithTheme, tokensToHast, transformerDecorations };
+export { BundledHighlighterOptions, CodeToHastOptions, CodeToHastRenderOptions, CodeToTokensBaseOptions, CodeToTokensOptions, CodeToTokensWithThemesOptions, type CreateHighlighterFactory, CreatedBundledHighlighterOptions, GrammarState, HighlighterCore, HighlighterCoreOptions, HighlighterGeneric, JavaScriptRegexEngineOptions, LanguageInput, LoadWasmOptions, MaybeArray, MaybeGetter, PlainTextLanguage, Position, RegexEngine, 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, createHighlighterCoreSync, createJavaScriptRegexEngine, createPositionConverter, createShikiInternal, createShikiInternalSync, createSingletonShorthands, createWasmOnigEngine, createdBundledHighlighter, defaultJavaScriptRegexConstructor, getHighlighterCore, getShikiInternal, getSingletonHighlighterCore, getTokenStyleObject, toHtml as hastToHtml, isNoneTheme, isPlainLang, isSpecialLang, isSpecialTheme, loadWasm, makeSingletonHighlighter, makeSingletonHighlighterCore, normalizeGetter, normalizeTheme, resolveColorReplacements, setDefaultWasmLoader, splitLines, splitToken, splitTokens, stringifyTokenStyle, toArray, tokenizeAnsiWithTheme, tokenizeWithTheme, tokensToHast, transformerDecorations };