@shikijs/core 3.23.0 → 4.0.0

package/dist/index.d.mts

@@ -1,8 +1,10 @@
-import { HighlighterGeneric, Awaitable, CodeToHastOptions, CodeToTokensOptions, TokensResult, RequireKeys, CodeToTokensBaseOptions, ThemedToken, CodeToTokensWithThemesOptions, ThemedTokenWithVariants, BundledHighlighterOptions, GrammarState, CreateBundledHighlighterOptions, CreateHighlighterFactory, HighlighterCoreOptions, HighlighterCore, ShikiInternal, ShikiTransformerContextCommon, CodeToHastRenderOptions, ShikiTransformerContextSource, ThemeRegistrationResolved, TokenizeWithThemeOptions, Grammar, ThemeRegistrationAny, ThemeRegistration, ShikiTransformer, ThemeInput, PlainTextLanguage, SpecialLanguage, SpecialTheme, MaybeGetter, MaybeArray, Position, CodeOptionsMultipleThemes, TokenStyles } from '@shikijs/types';
-export * from '@shikijs/types';
-import { Root, Element } from 'hast';
-import { toHtml } from 'hast-util-to-html';
+import { Awaitable, BundledHighlighterOptions, CodeOptionsMultipleThemes, CodeToHastOptions, CodeToHastRenderOptions, CodeToTokensBaseOptions, CodeToTokensOptions, CodeToTokensWithThemesOptions, CreateBundledHighlighterOptions, CreateHighlighterFactory, GrammarState, HighlighterCore, HighlighterCoreOptions, HighlighterGeneric, Position, RequireKeys, ShikiPrimitive, ShikiTransformer, ShikiTransformerContextCommon, ShikiTransformerContextSource, ThemeRegistration, ThemeRegistrationResolved, ThemedToken, ThemedTokenWithVariants, TokenStyles, TokenizeWithThemeOptions, TokensResult } from "@shikijs/types";
+import { ShikiError, applyColorReplacements, codeToTokensWithThemes, createShikiInternal, createShikiInternalSync, createShikiPrimitive, createShikiPrimitiveAsync, getLastGrammarState, isNoneTheme, isPlainLang, isSpecialLang, isSpecialTheme, normalizeGetter, normalizeTheme, resolveColorReplacements, splitLines, toArray, tokenizeWithTheme } from "@shikijs/primitive";
+import { toHtml } from "hast-util-to-html";
+import { Element, Root } from "hast";
+export * from "@shikijs/types";
 
+//#region src/constructors/bundle-factory.d.ts
 /**
  * Create a `createHighlighter` function with bundled themes, languages, and engine.
  *
@@ -25,64 +27,61 @@ import { toHtml } from 'hast-util-to-html';
  */
 declare function createBundledHighlighter<BundledLangs extends string, BundledThemes extends string>(options: CreateBundledHighlighterOptions<BundledLangs, BundledThemes>): CreateHighlighterFactory<BundledLangs, BundledThemes>;
 interface ShorthandsBundle<L extends string, T extends string> {
-    /**
-     * Shorthand for `codeToHtml` with auto-loaded theme and language.
-     * A singleton highlighter it maintained internally.
-     *
-     * Differences from `highlighter.codeToHtml()`, this function is async.
-     */
-    codeToHtml: (code: string, options: CodeToHastOptions<L, T>) => Promise<string>;
-    /**
-     * Shorthand for `codeToHtml` with auto-loaded theme and language.
-     * A singleton highlighter it maintained internally.
-     *
-     * Differences from `highlighter.codeToHtml()`, this function is async.
-     */
-    codeToHast: (code: string, options: CodeToHastOptions<L, T>) => Promise<Root>;
-    /**
-     * Shorthand for `codeToTokens` with auto-loaded theme and language.
-     * A singleton highlighter it maintained internally.
-     *
-     * Differences from `highlighter.codeToTokens()`, this function is async.
-     */
-    codeToTokens: (code: string, options: CodeToTokensOptions<L, T>) => Promise<TokensResult>;
-    /**
-     * Shorthand for `codeToTokensBase` with auto-loaded theme and language.
-     * A singleton highlighter it maintained internally.
-     *
-     * Differences from `highlighter.codeToTokensBase()`, this function is async.
-     */
-    codeToTokensBase: (code: string, options: RequireKeys<CodeToTokensBaseOptions<L, T>, 'theme' | 'lang'>) => Promise<ThemedToken[][]>;
-    /**
-     * Shorthand for `codeToTokensWithThemes` with auto-loaded theme and language.
-     * A singleton highlighter it maintained internally.
-     *
-     * Differences from `highlighter.codeToTokensWithThemes()`, this function is async.
-     */
-    codeToTokensWithThemes: (code: string, options: RequireKeys<CodeToTokensWithThemesOptions<L, T>, 'themes' | 'lang'>) => Promise<ThemedTokenWithVariants[][]>;
-    /**
-     * Get the singleton highlighter.
-     */
-    getSingletonHighlighter: (options?: Partial<BundledHighlighterOptions<L, T>>) => Promise<HighlighterGeneric<L, T>>;
-    /**
-     * Shorthand for `getLastGrammarState` with auto-loaded theme and language.
-     * A singleton highlighter it maintained internally.
-     */
-    getLastGrammarState: ((element: ThemedToken[][] | Root) => GrammarState) | ((code: string, options: CodeToTokensBaseOptions<L, T>) => Promise<GrammarState>);
+  /**
+   * Shorthand for `codeToHtml` with auto-loaded theme and language.
+   * A singleton highlighter it maintained internally.
+   *
+   * Differences from `highlighter.codeToHtml()`, this function is async.
+   */
+  codeToHtml: (code: string, options: CodeToHastOptions<L, T>) => Promise<string>;
+  /**
+   * Shorthand for `codeToHtml` with auto-loaded theme and language.
+   * A singleton highlighter it maintained internally.
+   *
+   * Differences from `highlighter.codeToHtml()`, this function is async.
+   */
+  codeToHast: (code: string, options: CodeToHastOptions<L, T>) => Promise<Root>;
+  /**
+   * Shorthand for `codeToTokens` with auto-loaded theme and language.
+   * A singleton highlighter it maintained internally.
+   *
+   * Differences from `highlighter.codeToTokens()`, this function is async.
+   */
+  codeToTokens: (code: string, options: CodeToTokensOptions<L, T>) => Promise<TokensResult>;
+  /**
+   * Shorthand for `codeToTokensBase` with auto-loaded theme and language.
+   * A singleton highlighter it maintained internally.
+   *
+   * Differences from `highlighter.codeToTokensBase()`, this function is async.
+   */
+  codeToTokensBase: (code: string, options: RequireKeys<CodeToTokensBaseOptions<L, T>, 'theme' | 'lang'>) => Promise<ThemedToken[][]>;
+  /**
+   * Shorthand for `codeToTokensWithThemes` with auto-loaded theme and language.
+   * A singleton highlighter it maintained internally.
+   *
+   * Differences from `highlighter.codeToTokensWithThemes()`, this function is async.
+   */
+  codeToTokensWithThemes: (code: string, options: RequireKeys<CodeToTokensWithThemesOptions<L, T>, 'themes' | 'lang'>) => Promise<ThemedTokenWithVariants[][]>;
+  /**
+   * Get the singleton highlighter.
+   */
+  getSingletonHighlighter: (options?: Partial<BundledHighlighterOptions<L, T>>) => Promise<HighlighterGeneric<L, T>>;
+  /**
+   * Shorthand for `getLastGrammarState` with auto-loaded theme and language.
+   * A singleton highlighter it maintained internally.
+   */
+  getLastGrammarState: ((element: ThemedToken[][] | Root) => GrammarState) | ((code: string, options: CodeToTokensBaseOptions<L, T>) => Promise<GrammarState>);
 }
 declare function makeSingletonHighlighter<L extends string, T extends string>(createHighlighter: CreateHighlighterFactory<L, T>): (options?: Partial<BundledHighlighterOptions<L, T>>) => Promise<HighlighterGeneric<L, T>>;
 interface CreateSingletonShorthandsOptions<L extends string, T extends string> {
-    /**
-     * A custom function to guess embedded languages to be loaded.
-     */
-    guessEmbeddedLanguages?: (code: string, lang: string | undefined, highlighter: HighlighterGeneric<L, T>) => Awaitable<string[] | undefined>;
+  /**
+   * A custom function to guess embedded languages to be loaded.
+   */
+  guessEmbeddedLanguages?: (code: string, lang: string | undefined, highlighter: HighlighterGeneric<L, T>) => Awaitable<string[] | undefined>;
 }
 declare function createSingletonShorthands<L extends string, T extends string>(createHighlighter: CreateHighlighterFactory<L, T>, config?: CreateSingletonShorthandsOptions<L, T>): ShorthandsBundle<L, T>;
-/**
- * @deprecated Use `createBundledHighlighter` instead.
- */
-declare const createdBundledHighlighter: typeof createBundledHighlighter;
-
+//#endregion
+//#region src/constructors/highlighter.d.ts
 /**
  * Create a Shiki core highlighter instance, with no languages or themes bundled.
  * Wasm and each language and theme must be loaded manually.
@@ -101,78 +100,62 @@ declare function createHighlighterCore(options: HighlighterCoreOptions<false>):
 declare function createHighlighterCoreSync(options: HighlighterCoreOptions<true>): HighlighterCore;
 declare function makeSingletonHighlighterCore(createHighlighter: typeof createHighlighterCore): (options: HighlighterCoreOptions) => Promise<HighlighterCore>;
 declare const getSingletonHighlighterCore: (options: HighlighterCoreOptions) => Promise<HighlighterCore>;
-
-/**
- * Get the minimal shiki context for rendering.
- */
-declare function createShikiInternal(options: HighlighterCoreOptions): Promise<ShikiInternal>;
-
-/**
- * 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;
-
-declare function codeToHast(internal: ShikiInternal, code: string, options: CodeToHastOptions, transformerContext?: ShikiTransformerContextCommon): Root;
+//#endregion
+//#region src/highlight/code-to-hast.d.ts
+declare function codeToHast(primitive: ShikiPrimitive, code: string, options: CodeToHastOptions, transformerContext?: ShikiTransformerContextCommon): Root;
 declare function tokensToHast(tokens: ThemedToken[][], options: CodeToHastRenderOptions, transformerContext: ShikiTransformerContextSource, grammarState?: GrammarState | undefined): Root;
-
+//#endregion
+//#region src/highlight/code-to-html.d.ts
 declare const hastToHtml: typeof toHtml;
 /**
  * Get highlighted code in HTML.
  */
-declare function codeToHtml(internal: ShikiInternal, code: string, options: CodeToHastOptions): string;
-
+declare function codeToHtml(primitive: ShikiPrimitive, code: string, options: CodeToHastOptions): string;
+//#endregion
+//#region src/highlight/code-to-tokens.d.ts
 /**
  * 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 codeToTokens(primitive: ShikiPrimitive, code: string, options: CodeToTokensOptions): TokensResult;
+//#endregion
+//#region src/highlight/code-to-tokens-ansi.d.ts
 declare function tokenizeAnsiWithTheme(theme: ThemeRegistrationResolved, fileContents: string, options?: TokenizeWithThemeOptions): ThemedToken[][];
-
+//#endregion
+//#region src/highlight/code-to-tokens-base.d.ts
 /**
  * Code to tokens, with a simple theme.
+ * This wraps the tokenizer's implementation to add ANSI support.
  */
-declare function codeToTokensBase(internal: ShikiInternal, code: string, options?: CodeToTokensBaseOptions): ThemedToken[][];
-declare function tokenizeWithTheme(code: string, grammar: Grammar, 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;
-
+declare function codeToTokensBase(primitive: ShikiPrimitive, code: string, options?: CodeToTokensBaseOptions): ThemedToken[][];
+//#endregion
+//#region src/theme-css-variables.d.ts
 interface CssVariablesThemeOptions {
-    /**
-     * Theme name. Need to unique if multiple css variables themes are created
-     *
-     * @default 'css-variables'
-     */
-    name?: string;
-    /**
-     * Prefix for css variables
-     *
-     * @default '--shiki-'
-     */
-    variablePrefix?: string;
-    /**
-     * Default value for css variables, the key is without the prefix
-     *
-     * @example `{ 'token-comment': '#888' }` will generate `var(--shiki-token-comment, #888)` for comments
-     */
-    variableDefaults?: Record<string, string>;
-    /**
-     * Enable font style
-     *
-     * @default true
-     */
-    fontStyle?: boolean;
+  /**
+   * Theme name. Need to unique if multiple css variables themes are created
+   *
+   * @default 'css-variables'
+   */
+  name?: string;
+  /**
+   * Prefix for css variables
+   *
+   * @default '--shiki-'
+   */
+  variablePrefix?: string;
+  /**
+   * Default value for css variables, the key is without the prefix
+   *
+   * @example `{ 'token-comment': '#888' }` will generate `var(--shiki-token-comment, #888)` for comments
+   */
+  variableDefaults?: Record<string, string>;
+  /**
+   * Enable font style
+   *
+   * @default true
+   */
+  fontStyle?: boolean;
 }
 /**
  * A factory function to create a css-variable-based theme
@@ -180,79 +163,31 @@ interface CssVariablesThemeOptions {
  * @see https://shiki.style/guide/theme-colors#css-variables-theme
  */
 declare function createCssVariablesTheme(options?: CssVariablesThemeOptions): ThemeRegistration;
-
+//#endregion
+//#region src/transformer-decorations.d.ts
 /**
  * A built-in transformer to add decorations to the highlighted code.
  */
 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[];
-/**
- * Normalize a getter to a promise.
- */
-declare function normalizeGetter<T>(p: MaybeGetter<T>): Promise<T>;
-/**
- * Check if the language is plaintext that is ignored by Shiki.
- *
- * Hard-coded plain text languages: `plaintext`, `txt`, `text`, `plain`.
- */
-declare function isPlainLang(lang: string | null | undefined): lang is PlainTextLanguage;
-/**
- * Check if the language is specially handled or bypassed by Shiki.
- *
- * Hard-coded languages: `ansi` and plaintexts like `plaintext`, `txt`, `text`, `plain`.
- */
-declare function isSpecialLang(lang: any): lang is SpecialLanguage;
-/**
- * Check if the theme is specially handled or bypassed by Shiki.
- *
- * Hard-coded themes: `none`.
- */
-declare function isNoneTheme(theme: string | ThemeInput | null | undefined): theme is 'none';
-/**
- * Check if the theme is specially handled or bypassed by Shiki.
- *
- * Hard-coded themes: `none`.
- */
-declare function isSpecialTheme(theme: string | ThemeInput | null | undefined): theme is SpecialTheme;
-
+//#endregion
+//#region src/utils/hast.d.ts
 /**
  * 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 string into lines, each line preserves the line ending.
- *
- * @param code - The code string to split into lines
- * @param preserveEnding - Whether to preserve line endings in the result
- * @returns Array of tuples containing [line content, offset index]
- *
- * @example
- * ```ts
- * splitLines('hello\nworld', false)
- * // => [['hello', 0], ['world', 6]]
- *
- * splitLines('hello\nworld', true)
- * // => [['hello\n', 0], ['world', 6]]
- * ```
- */
-declare function splitLines(code: string, preserveEnding?: boolean): [string, number][];
+//#endregion
+//#region src/utils/strings.d.ts
 /**
  * Creates a converter between index and position in a code block.
  *
  * Overflow/underflow are unchecked.
  */
 declare function createPositionConverter(code: string): {
-    lines: string[];
-    indexToPos: (index: number) => Position;
-    posToIndex: (line: number, character: number) => number;
+  lines: string[];
+  indexToPos: (index: number) => Position;
+  posToIndex: (line: number, character: number) => number;
 };
 /**
  * Guess embedded languages from given code and highlighter.
@@ -274,7 +209,8 @@ declare function createPositionConverter(code: string): {
  * ```
  */
 declare function guessEmbeddedLanguages(code: string, _lang: string | undefined, highlighter?: HighlighterGeneric<any, any>): string[];
-
+//#endregion
+//#region src/utils/tokens.d.ts
 /**
  * Split a token into multiple tokens by given offsets.
  *
@@ -288,20 +224,5 @@ declare function splitTokens<T extends Pick<ThemedToken, 'content' | 'offset'>>(
 declare function flatTokenVariants(merged: ThemedTokenWithVariants, variantsOrder: string[], cssVariablePrefix: string, defaultColor: CodeOptionsMultipleThemes['defaultColor'], colorsRendering?: CodeOptionsMultipleThemes['colorsRendering']): 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.
- *
- * You can pass a major version to only warn for deprecations that will be removed in that version.
- *
- * By default, deprecation warning is set to 3 since Shiki v2.0.0
- */
-declare function enableDeprecationWarnings(emitDeprecation?: DeprecationTarget | boolean, emitError?: boolean): void;
-/**
- * @internal
- */
-declare function warnDeprecated(message: string, version?: DeprecationTarget): void;
-
-export { addClassToHast, applyColorReplacements, codeToHast, codeToHtml, codeToTokens, codeToTokensBase, codeToTokensWithThemes, createBundledHighlighter, createCssVariablesTheme, createHighlighterCore, createHighlighterCoreSync, createPositionConverter, createShikiInternal, createShikiInternalSync, createSingletonShorthands, createdBundledHighlighter, enableDeprecationWarnings, flatTokenVariants, getSingletonHighlighterCore, getTokenStyleObject, guessEmbeddedLanguages, hastToHtml, isNoneTheme, isPlainLang, isSpecialLang, isSpecialTheme, makeSingletonHighlighter, makeSingletonHighlighterCore, normalizeGetter, normalizeTheme, resolveColorReplacements, splitLines, splitToken, splitTokens, stringifyTokenStyle, toArray, tokenizeAnsiWithTheme, tokenizeWithTheme, tokensToHast, transformerDecorations, warnDeprecated };
-export type { CreateSingletonShorthandsOptions, CssVariablesThemeOptions, ShorthandsBundle };
+//#endregion
+export { CreateSingletonShorthandsOptions, CssVariablesThemeOptions, ShikiError, ShorthandsBundle, addClassToHast, applyColorReplacements, codeToHast, codeToHtml, codeToTokens, codeToTokensBase, codeToTokensWithThemes, createBundledHighlighter, createCssVariablesTheme, createHighlighterCore, createHighlighterCoreSync, createPositionConverter, createShikiInternal, createShikiInternalSync, createShikiPrimitive, createShikiPrimitiveAsync, createSingletonShorthands, flatTokenVariants, getLastGrammarState, getSingletonHighlighterCore, getTokenStyleObject, guessEmbeddedLanguages, hastToHtml, isNoneTheme, isPlainLang, isSpecialLang, isSpecialTheme, makeSingletonHighlighter, makeSingletonHighlighterCore, normalizeGetter, normalizeTheme, resolveColorReplacements, splitLines, splitToken, splitTokens, stringifyTokenStyle, toArray, tokenizeAnsiWithTheme, tokenizeWithTheme, tokensToHast, transformerDecorations };