full site update
This commit is contained in:
113
node_modules/@shikijs/core/dist/index.d.mts
generated
vendored
113
node_modules/@shikijs/core/dist/index.d.mts
generated
vendored
@@ -1,9 +1,7 @@
|
||||
import { CreatedBundledHighlighterOptions, CreateHighlighterFactory, LanguageInput, ThemeInput, HighlighterCoreOptions, CodeToHastOptions, CodeToTokensOptions, TokensResult, RequireKeys, CodeToTokensBaseOptions, ThemedToken, CodeToTokensWithThemesOptions, ThemedTokenWithVariants, BundledHighlighterOptions, HighlighterGeneric, GrammarState, HighlighterCore, ShikiInternal, RegexEngine, LoadWasmOptions, ShikiTransformerContextCommon, CodeToHastRenderOptions, ShikiTransformerContextSource, ThemeRegistrationResolved, TokenizeWithThemeOptions, Grammar, ThemeRegistrationAny, ThemeRegistration, ShikiTransformer, MaybeArray, PlainTextLanguage, SpecialLanguage, SpecialTheme, MaybeGetter, TokenStyles, Position } from '@shikijs/types';
|
||||
import { CreatedBundledHighlighterOptions, CreateHighlighterFactory, CodeToHastOptions, CodeToTokensOptions, TokensResult, RequireKeys, CodeToTokensBaseOptions, ThemedToken, CodeToTokensWithThemesOptions, ThemedTokenWithVariants, BundledHighlighterOptions, HighlighterGeneric, GrammarState, Awaitable, HighlighterCoreOptions, HighlighterCore, ShikiInternal, ShikiTransformerContextCommon, CodeToHastRenderOptions, ShikiTransformerContextSource, ThemeRegistrationResolved, TokenizeWithThemeOptions, Grammar, ThemeRegistrationAny, ThemeRegistration, ShikiTransformer, MaybeArray, MaybeGetter, PlainTextLanguage, SpecialLanguage, ThemeInput, SpecialTheme, Position, CodeOptionsMultipleThemes, TokenStyles } from '@shikijs/types';
|
||||
export * from '@shikijs/types';
|
||||
import { Root, Element } from 'hast';
|
||||
import { JavaScriptRegexEngineOptions } from '@shikijs/engine-javascript';
|
||||
export { FontStyle, EncodedTokenMetadata as StackElementMetadata } from '@shikijs/vscode-textmate';
|
||||
export { toHtml as hastToHtml } from 'hast-util-to-html';
|
||||
import { toHtml } from 'hast-util-to-html';
|
||||
|
||||
/**
|
||||
* Create a `createHighlighter` function with bundled themes, languages, and engine.
|
||||
@@ -26,12 +24,6 @@ export { toHtml as hastToHtml } from 'hast-util-to-html';
|
||||
* @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.
|
||||
@@ -79,7 +71,13 @@ interface ShorthandsBundle<L extends string, T extends string> {
|
||||
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>;
|
||||
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>;
|
||||
}
|
||||
declare function createSingletonShorthands<L extends string, T extends string>(createHighlighter: CreateHighlighterFactory<L, T>, config?: CreateSingletonShorthandsOptions<L, T>): ShorthandsBundle<L, T>;
|
||||
|
||||
/**
|
||||
* Create a Shiki core highlighter instance, with no languages or themes bundled.
|
||||
@@ -87,7 +85,7 @@ declare function createSingletonShorthands<L extends string, T extends string>(c
|
||||
*
|
||||
* @see http://shiki.style/guide/bundles#fine-grained-bundle
|
||||
*/
|
||||
declare function createHighlighterCore(options?: HighlighterCoreOptions): Promise<HighlighterCore>;
|
||||
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.
|
||||
@@ -96,22 +94,14 @@ declare function createHighlighterCore(options?: HighlighterCoreOptions): Promis
|
||||
*
|
||||
* @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>;
|
||||
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>;
|
||||
/**
|
||||
* @deprecated Use `createShikiInternal` instead.
|
||||
*/
|
||||
declare function getShikiInternal(options?: HighlighterCoreOptions): Promise<ShikiInternal>;
|
||||
declare function createShikiInternal(options: HighlighterCoreOptions): Promise<ShikiInternal>;
|
||||
|
||||
/**
|
||||
* Get the minimal shiki context for rendering.
|
||||
@@ -120,31 +110,10 @@ declare function getShikiInternal(options?: HighlighterCoreOptions): Promise<Shi
|
||||
*/
|
||||
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;
|
||||
|
||||
declare const hastToHtml: typeof toHtml;
|
||||
/**
|
||||
* Get highlighted code in HTML.
|
||||
*/
|
||||
@@ -213,11 +182,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.
|
||||
*
|
||||
@@ -242,31 +215,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.
|
||||
* Split a string into lines, each line preserves the line ending.
|
||||
*/
|
||||
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;
|
||||
declare function splitLines(code: string, preserveEnding?: boolean): [string, number][];
|
||||
/**
|
||||
* Creates a converter between index and position in a code block.
|
||||
*
|
||||
@@ -277,6 +237,26 @@ declare function createPositionConverter(code: string): {
|
||||
indexToPos: (index: number) => Position;
|
||||
posToIndex: (line: number, character: number) => number;
|
||||
};
|
||||
/**
|
||||
* Guess embedded languages from given code and highlighter.
|
||||
*
|
||||
* When highlighter is provided, only bundled languages will be included.
|
||||
*/
|
||||
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: 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;
|
||||
/**
|
||||
@@ -292,4 +272,5 @@ declare function enableDeprecationWarnings(emitDeprecation?: DeprecationTarget |
|
||||
*/
|
||||
declare function warnDeprecated(message: string, version?: DeprecationTarget): void;
|
||||
|
||||
export { type CssVariablesThemeOptions, type ShorthandsBundle, addClassToHast, applyColorReplacements, codeToHast, codeToHtml, codeToTokens, codeToTokensBase, codeToTokensWithThemes, createCssVariablesTheme, createHighlighterCore, createHighlighterCoreSync, createJavaScriptRegexEngine, createOnigurumaEngine, createPositionConverter, createShikiInternal, createShikiInternalSync, createSingletonShorthands, createWasmOnigEngine, createdBundledHighlighter, defaultJavaScriptRegexConstructor, enableDeprecationWarnings, getHighlighterCore, getShikiInternal, getSingletonHighlighterCore, getTokenStyleObject, isNoneTheme, isPlainLang, isSpecialLang, isSpecialTheme, loadWasm, makeSingletonHighlighter, makeSingletonHighlighterCore, normalizeGetter, normalizeTheme, resolveColorReplacements, splitLines, splitToken, splitTokens, stringifyTokenStyle, toArray, tokenizeAnsiWithTheme, tokenizeWithTheme, tokensToHast, transformerDecorations, warnDeprecated };
|
||||
export { addClassToHast, applyColorReplacements, codeToHast, codeToHtml, codeToTokens, codeToTokensBase, codeToTokensWithThemes, 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 };
|
||||
|
||||
Reference in New Issue
Block a user