shiki 2.3.0 → 2.3.2

package/dist/types/theme-css-variables.d.mts

@@ -1,634 +0,0 @@
-import { CodeToHastOptions, CodeToTokensOptions, TokensResult, RequireKeys, CodeToTokensBaseOptions, ThemedToken, CodeToTokensWithThemesOptions, ThemedTokenWithVariants, BundledHighlighterOptions, HighlighterGeneric, GrammarState, ThemeRegistration, HighlighterCoreOptions, HighlighterCore, Position as Position$1, ShikiInternal, CreateHighlighterFactory, LoadWasmOptions, RegexEngine, CreatedBundledHighlighterOptions, LanguageInput, ThemeInput, TokenStyles, PlainTextLanguage, SpecialLanguage, SpecialTheme, MaybeGetter, ThemeRegistrationAny, ThemeRegistrationResolved, TokenizeWithThemeOptions, MaybeArray, Grammar, CodeToHastRenderOptions, ShikiTransformerContextSource, ShikiTransformer, ShikiTransformerContextCommon } from '@shikijs/types';
-import { JavaScriptRegexEngineOptions } from '@shikijs/engine-javascript';
-
-// ## Interfaces
-
-/**
- * Info associated with nodes by the ecosystem.
- *
- * This space is guaranteed to never be specified by unist or specifications
- * implementing unist.
- * But you can use it in utilities and plugins to store data.
- *
- * This type can be augmented to register custom data.
- * For example:
- *
- * ```ts
- * declare module 'unist' {
- *   interface Data {
- *     // `someNode.data.myId` is typed as `number | undefined`
- *     myId?: number | undefined
- *   }
- * }
- * ```
- */
-interface Data$1 {}
-
-/**
- * One place in a source file.
- */
-interface Point {
-    /**
-     * Line in a source file (1-indexed integer).
-     */
-    line: number;
-
-    /**
-     * Column in a source file (1-indexed integer).
-     */
-    column: number;
-    /**
-     * Character in a source file (0-indexed integer).
-     */
-    offset?: number | undefined;
-}
-
-/**
- * Position of a node in a source document.
- *
- * A position is a range between two points.
- */
-interface Position {
-    /**
-     * Place of the first character of the parsed source region.
-     */
-    start: Point;
-
-    /**
-     * Place of the first character after the parsed source region.
-     */
-    end: Point;
-}
-
-/**
- * Abstract unist node.
- *
- * The syntactic unit in unist syntax trees are called nodes.
- *
- * This interface is supposed to be extended.
- * If you can use {@link Literal} or {@link Parent}, you should.
- * But for example in markdown, a `thematicBreak` (`***`), is neither literal
- * nor parent, but still a node.
- */
-interface Node$1 {
-    /**
-     * Node type.
-     */
-    type: string;
-
-    /**
-     * Info from the ecosystem.
-     */
-    data?: Data$1 | undefined;
-
-    /**
-     * Position of a node in a source document.
-     *
-     * Nodes that are generated (not in the original source document) must not
-     * have a position.
-     */
-    position?: Position | undefined;
-}
-
-// ## Interfaces
-
-/**
- * Info associated with hast nodes by the ecosystem.
- *
- * This space is guaranteed to never be specified by unist or hast.
- * But you can use it in utilities and plugins to store data.
- *
- * This type can be augmented to register custom data.
- * For example:
- *
- * ```ts
- * declare module 'hast' {
- *   interface Data {
- *     // `someNode.data.myId` is typed as `number | undefined`
- *     myId?: number | undefined
- *   }
- * }
- * ```
- */
-interface Data extends Data$1 {}
-
-/**
- * Info associated with an element.
- */
-interface Properties {
-    [PropertyName: string]: boolean | number | string | null | undefined | Array<string | number>;
-}
-
-// ## Content maps
-
-/**
- * Union of registered hast nodes that can occur in {@link Element}.
- *
- * To register mote custom hast nodes, add them to {@link ElementContentMap}.
- * They will be automatically added here.
- */
-type ElementContent = ElementContentMap[keyof ElementContentMap];
-
-/**
- * Registry of all hast nodes that can occur as children of {@link Element}.
- *
- * For a union of all {@link Element} children, see {@link ElementContent}.
- */
-interface ElementContentMap {
-    comment: Comment;
-    element: Element;
-    text: Text;
-}
-
-/**
- * Union of registered hast nodes that can occur in {@link Root}.
- *
- * To register custom hast nodes, add them to {@link RootContentMap}.
- * They will be automatically added here.
- */
-type RootContent = RootContentMap[keyof RootContentMap];
-
-/**
- * Registry of all hast nodes that can occur as children of {@link Root}.
- *
- * > 👉 **Note**: {@link Root} does not need to be an entire document.
- * > it can also be a fragment.
- *
- * For a union of all {@link Root} children, see {@link RootContent}.
- */
-interface RootContentMap {
-    comment: Comment;
-    doctype: Doctype;
-    element: Element;
-    text: Text;
-}
-
-/**
- * Union of registered hast nodes.
- *
- * To register custom hast nodes, add them to {@link RootContentMap} and other
- * places where relevant.
- * They will be automatically added here.
- */
-type Nodes = Root | RootContent;
-
-// ## Abstract nodes
-
-/**
- * Abstract hast node.
- *
- * This interface is supposed to be extended.
- * If you can use {@link Literal} or {@link Parent}, you should.
- * But for example in HTML, a `Doctype` is neither literal nor parent, but
- * still a node.
- *
- * To register custom hast nodes, add them to {@link RootContentMap} and other
- * places where relevant (such as {@link ElementContentMap}).
- *
- * For a union of all registered hast nodes, see {@link Nodes}.
- */
-interface Node extends Node$1 {
-    /**
-     * Info from the ecosystem.
-     */
-    data?: Data | undefined;
-}
-
-/**
- * Abstract hast node that contains the smallest possible value.
- *
- * This interface is supposed to be extended if you make custom hast nodes.
- *
- * For a union of all registered hast literals, see {@link Literals}.
- */
-interface Literal extends Node {
-    /**
-     * Plain-text value.
-     */
-    value: string;
-}
-
-/**
- * Abstract hast node that contains other hast nodes (*children*).
- *
- * This interface is supposed to be extended if you make custom hast nodes.
- *
- * For a union of all registered hast parents, see {@link Parents}.
- */
-interface Parent extends Node {
-    /**
-     * List of children.
-     */
-    children: RootContent[];
-}
-
-// ## Concrete nodes
-
-/**
- * HTML comment.
- */
-interface Comment extends Literal {
-    /**
-     * Node type of HTML comments in hast.
-     */
-    type: "comment";
-    /**
-     * Data associated with the comment.
-     */
-    data?: CommentData | undefined;
-}
-
-/**
- * Info associated with hast comments by the ecosystem.
- */
-interface CommentData extends Data {}
-
-/**
- * HTML document type.
- */
-interface Doctype extends Node$1 {
-    /**
-     * Node type of HTML document types in hast.
-     */
-    type: "doctype";
-    /**
-     * Data associated with the doctype.
-     */
-    data?: DoctypeData | undefined;
-}
-
-/**
- * Info associated with hast doctypes by the ecosystem.
- */
-interface DoctypeData extends Data {}
-
-/**
- * HTML element.
- */
-interface Element extends Parent {
-    /**
-     * Node type of elements.
-     */
-    type: "element";
-    /**
-     * Tag name (such as `'body'`) of the element.
-     */
-    tagName: string;
-    /**
-     * Info associated with the element.
-     */
-    properties: Properties;
-    /**
-     * Children of element.
-     */
-    children: ElementContent[];
-    /**
-     * When the `tagName` field is `'template'`, a `content` field can be
-     * present.
-     */
-    content?: Root | undefined;
-    /**
-     * Data associated with the element.
-     */
-    data?: ElementData | undefined;
-}
-
-/**
- * Info associated with hast elements by the ecosystem.
- */
-interface ElementData extends Data {}
-
-/**
- * Document fragment or a whole document.
- *
- * Should be used as the root of a tree and must not be used as a child.
- *
- * Can also be used as the value for the content field on a `'template'` element.
- */
-interface Root extends Parent {
-    /**
-     * Node type of hast root.
-     */
-    type: "root";
-    /**
-     * Children of root.
-     */
-    children: RootContent[];
-    /**
-     * Data associated with the hast root.
-     */
-    data?: RootData | undefined;
-}
-
-/**
- * Info associated with hast root nodes by the ecosystem.
- */
-interface RootData extends Data {}
-
-/**
- * HTML character data (plain text).
- */
-interface Text extends Literal {
-    /**
-     * Node type of HTML character data (plain text) in hast.
-     */
-    type: "text";
-    /**
-     * Data associated with the text.
-     */
-    data?: TextData | undefined;
-}
-
-/**
- * Info associated with hast texts by the ecosystem.
- */
-interface TextData extends Data {}
-
-/**
- * Create a `createHighlighter` function with bundled themes, languages, and engine.
- *
- * @example
- * ```ts
- * const createHighlighter = createdBundledHighlighter({
- *   langs: {
- *     typescript: () => import('@shikijs/langs/typescript'),
- *     // ...
- *   },
- *   themes: {
- *     nord: () => import('@shikijs/themes/nord'),
- *     // ...
- *   },
- *   engine: () => createOnigurumaEngine(), // or createJavaScriptRegexEngine()
- * })
- * ```
- *
- * @param options
- */
-declare function createdBundledHighlighter<BundledLangs extends string, BundledThemes extends string>(options: CreatedBundledHighlighterOptions<BundledLangs, BundledThemes>): CreateHighlighterFactory<BundledLangs, BundledThemes>;
-/**
- * Create a `createHighlighter` function with bundled themes and languages.
- *
- * @deprecated Use `createdBundledHighlighter({ langs, themes, engine })` signature instead.
- */
-declare function createdBundledHighlighter<BundledLangs extends string, BundledThemes extends string>(bundledLanguages: Record<BundledLangs, LanguageInput>, bundledThemes: Record<BundledThemes, ThemeInput>, loadWasm: HighlighterCoreOptions['loadWasm']): 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>);
-}
-declare function makeSingletonHighlighter<L extends string, T extends string>(createHighlighter: CreateHighlighterFactory<L, T>): (options?: Partial<BundledHighlighterOptions<L, T>>) => Promise<HighlighterGeneric<L, T>>;
-declare function createSingletonShorthands<L extends string, T extends string>(createHighlighter: CreateHighlighterFactory<L, T>): ShorthandsBundle<L, T>;
-
-/**
- * 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<false>): 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: HighlighterCoreOptions) => Promise<HighlighterCore>;
-declare const getSingletonHighlighterCore: (options: HighlighterCoreOptions) => Promise<HighlighterCore>;
-/**
- * @deprecated Use `createHighlighterCore` or `getSingletonHighlighterCore` instead.
- */
-declare function getHighlighterCore(options: HighlighterCoreOptions): Promise<HighlighterCore>;
-
-/**
- * Get the minimal shiki context for rendering.
- */
-declare function createShikiInternal(options: HighlighterCoreOptions): Promise<ShikiInternal>;
-/**
- * @deprecated Use `createShikiInternal` instead.
- */
-declare function getShikiInternal(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;
-
-/**
- * @deprecated Import `createJavaScriptRegexEngine` from `@shikijs/engine-javascript` or `shiki/engine/javascript` instead.
- */
-declare function createJavaScriptRegexEngine(options?: JavaScriptRegexEngineOptions): RegexEngine;
-/**
- * @deprecated Import `defaultJavaScriptRegexConstructor` from `@shikijs/engine-javascript` or `shiki/engine/javascript` instead.
- */
-declare function defaultJavaScriptRegexConstructor(pattern: string): RegExp;
-
-/**
- * @deprecated Import `createOnigurumaEngine` from `@shikijs/engine-oniguruma` or `shiki/engine/oniguruma` instead.
- */
-declare function createOnigurumaEngine(options?: LoadWasmOptions | null): Promise<RegexEngine>;
-/**
- * @deprecated Import `createOnigurumaEngine` from `@shikijs/engine-oniguruma` or `shiki/engine/oniguruma` instead.
- */
-declare function createWasmOnigEngine(options?: LoadWasmOptions | null): Promise<RegexEngine>;
-/**
- * @deprecated Import `loadWasm` from `@shikijs/engine-oniguruma` or `shiki/engine/oniguruma` instead.
- */
-declare function loadWasm(options: LoadWasmOptions): Promise<void>;
-
-declare function codeToHast(internal: ShikiInternal, code: string, options: CodeToHastOptions, transformerContext?: ShikiTransformerContextCommon): Root;
-declare function tokensToHast(tokens: ThemedToken[][], options: CodeToHastRenderOptions, transformerContext: ShikiTransformerContextSource, grammarState?: GrammarState | undefined): Root;
-
-/**
- * Get highlighted code in HTML.
- */
-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: 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;
-
-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;
-}
-/**
- * A factory function to create a css-variable-based theme
- *
- * @see https://shiki.style/guide/theme-colors#css-variables-theme
- */
-declare function createCssVariablesTheme(options?: CssVariablesThemeOptions): ThemeRegistration;
-
-/**
- * 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.
- */
-declare function splitLines(code: string, preserveEnding?: boolean): [string, number][];
-/**
- * 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;
-/**
- * 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.
- */
-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;
-/**
- * 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$1;
-    posToIndex: (line: number, character: number) => number;
-};
-
-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 { splitToken as A, splitTokens as B, type CssVariablesThemeOptions as C, stringifyTokenStyle as D, toArray as E, tokenizeAnsiWithTheme as F, tokenizeWithTheme as G, tokensToHast as H, transformerDecorations as I, warnDeprecated as J, createJavaScriptRegexEngine as K, createOnigurumaEngine as L, defaultJavaScriptRegexConstructor as M, loadWasm as N, type RootContent as O, type Nodes as P, codeToHast as Q, type Root as R, type ShorthandsBundle as S, codeToHtml as T, codeToTokens as U, codeToTokensBase as V, codeToTokensWithThemes as W, addClassToHast as a, applyColorReplacements as b, createCssVariablesTheme as c, createHighlighterCore as d, createHighlighterCoreSync as e, createPositionConverter as f, createShikiInternal as g, createShikiInternalSync as h, createSingletonShorthands as i, createWasmOnigEngine as j, createdBundledHighlighter as k, enableDeprecationWarnings as l, getHighlighterCore as m, getShikiInternal as n, getSingletonHighlighterCore as o, getTokenStyleObject as p, isNoneTheme as q, isPlainLang as r, isSpecialLang as s, isSpecialTheme as t, makeSingletonHighlighter as u, makeSingletonHighlighterCore as v, normalizeGetter as w, normalizeTheme as x, resolveColorReplacements as y, splitLines as z };