@shikijs/core 1.16.2 → 1.16.3

package/dist/types.d.mts

@@ -1,8 +1,60 @@
-import { Root, Element } from 'hast';
+import { Element, Root } from 'hast';
+import { b as MaybeGetter, M as MaybeArray, a as RegexEngine, A as Awaitable, L as LoadWasmOptions, S as StringLiteralUnion } from './chunk-engines.mjs';
+export { J as JavaScriptRegexEngineOptions, e as LoadWasmOptionsPlain, f as MaybeModule, O as OnigurumaLoadOptions, P as PatternScanner, c as RegexEngineString, R as RequireKeys, d as WebAssemblyInstance, W as WebAssemblyInstantiator } from './chunk-engines.mjs';
 import { IGrammar, IRawGrammar, IRawTheme, IRawThemeSetting, StateStack } from '@shikijs/vscode-textmate';
 export { IRawGrammar as RawGrammar, IRawTheme as RawTheme, IRawThemeSetting as RawThemeSetting } from '@shikijs/vscode-textmate';
-import { b as MaybeGetter, M as MaybeArray, a as RegexEngine, A as Awaitable, L as LoadWasmOptions, S as StringLiteralUnion } from './chunk-engines.mjs';
-export { J as JavaScriptRegexEngineOptions, f as LoadWasmOptionsPlain, c as MaybeModule, O as OnigurumaLoadOptions, P as PatternScanner, d as RegexEngineString, R as RequireKeys, e as WebAssemblyInstance, W as WebAssemblyInstantiator } from './chunk-engines.mjs';
+
+interface DecorationOptions {
+    /**
+     * Custom decorations to wrap highlighted tokens with.
+     */
+    decorations?: DecorationItem[];
+}
+interface DecorationItem {
+    /**
+     * Start offset or position of the decoration.
+     */
+    start: OffsetOrPosition;
+    /**
+     * End offset or position of the decoration.
+     */
+    end: OffsetOrPosition;
+    /**
+     * Tag name of the element to create.
+     * @default 'span'
+     */
+    tagName?: string;
+    /**
+     * Properties of the element to create.
+     */
+    properties?: Element['properties'];
+    /**
+     * A custom function to transform the element after it has been created.
+     */
+    transform?: (element: Element, type: DecorationTransformType) => Element | void;
+    /**
+     * By default when the decoration contains only one token, the decoration will be applied to the token.
+     *
+     * Set to `true` to always wrap the token with a new element
+     *
+     * @default false
+     */
+    alwaysWrap?: boolean;
+}
+interface ResolvedDecorationItem extends Omit<DecorationItem, 'start' | 'end'> {
+    start: ResolvedPosition;
+    end: ResolvedPosition;
+}
+type DecorationTransformType = 'wrapper' | 'line' | 'token';
+interface Position {
+    line: number;
+    character: number;
+}
+type Offset = number;
+type OffsetOrPosition = Position | Offset;
+interface ResolvedPosition extends Position {
+    offset: Offset;
+}
 
 interface Grammar extends IGrammar {
     name: string;
@@ -142,306 +194,23 @@ interface BundledThemeInfo {
  * GrammarState is a special reference object that holds the state of a grammar.
  *
  * It's used to highlight code snippets that are part of the target language.
- */
-declare class GrammarState {
-    private readonly _stack;
-    readonly lang: string;
-    readonly theme: string;
-    /**
-     * Static method to create a initial grammar state.
-     */
-    static initial(lang: string, theme: string): GrammarState;
-    constructor(_stack: StateStack, lang: string, theme: string);
-    get scopes(): string[];
-    toJSON(): {
-        lang: string;
-        theme: string;
-        scopes: string[];
-    };
-}
-
-interface TransformerOptions {
-    /**
-     * Transformers for the Shiki pipeline.
-     */
-    transformers?: ShikiTransformer[];
-}
-interface ShikiTransformerContextMeta {
-}
-/**
- * Common transformer context for all transformers hooks
- */
-interface ShikiTransformerContextCommon {
-    meta: ShikiTransformerContextMeta;
-    options: CodeToHastOptions;
-    codeToHast: (code: string, options: CodeToHastOptions) => Root;
-    codeToTokens: (code: string, options: CodeToTokensOptions) => TokensResult;
-}
-interface ShikiTransformerContextSource extends ShikiTransformerContextCommon {
-    readonly source: string;
-}
-/**
- * Transformer context for HAST related hooks
- */
-interface ShikiTransformerContext extends ShikiTransformerContextSource {
-    readonly tokens: ThemedToken[][];
-    readonly root: Root;
-    readonly pre: Element;
-    readonly code: Element;
-    readonly lines: Element[];
-    readonly structure: CodeToHastOptions['structure'];
-    /**
-     * 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.
-     */
-    addClassToHast: (hast: Element, className: string | string[]) => Element;
-}
-interface ShikiTransformer {
-    /**
-     * Name of the transformer
-     */
-    name?: string;
-    /**
-     * Transform the raw input code before passing to the highlighter.
-     */
-    preprocess?: (this: ShikiTransformerContextCommon, code: string, options: CodeToHastOptions) => string | void;
-    /**
-     * Transform the full tokens list before converting to HAST.
-     * Return a new tokens list will replace the original one.
-     */
-    tokens?: (this: ShikiTransformerContextSource, tokens: ThemedToken[][]) => ThemedToken[][] | void;
-    /**
-     * Transform the entire generated HAST tree. Return a new Node will replace the original one.
-     */
-    root?: (this: ShikiTransformerContext, hast: Root) => Root | void;
-    /**
-     * Transform the `<pre>` element. Return a new Node will replace the original one.
-     */
-    pre?: (this: ShikiTransformerContext, hast: Element) => Element | void;
-    /**
-     * Transform the `<code>` element. Return a new Node will replace the original one.
-     */
-    code?: (this: ShikiTransformerContext, hast: Element) => Element | void;
-    /**
-     * Transform each line `<span class="line">` element.
-     *
-     * @param hast
-     * @param line 1-based line number
-     */
-    line?: (this: ShikiTransformerContext, hast: Element, line: number) => Element | void;
-    /**
-     * Transform each token `<span>` element.
-     */
-    span?: (this: ShikiTransformerContext, hast: Element, line: number, col: number, lineElement: Element) => Element | void;
-    /**
-     * Transform the generated HTML string before returning.
-     * This hook will only be called with `codeToHtml`.
-     */
-    postprocess?: (this: ShikiTransformerContextCommon, html: string, options: CodeToHastOptions) => string | void;
-}
-
-interface DecorationOptions {
-    /**
-     * Custom decorations to wrap highlighted tokens with.
-     */
-    decorations?: DecorationItem[];
-}
-interface DecorationItem {
-    /**
-     * Start offset or position of the decoration.
-     */
-    start: OffsetOrPosition;
-    /**
-     * End offset or position of the decoration.
-     */
-    end: OffsetOrPosition;
-    /**
-     * Tag name of the element to create.
-     * @default 'span'
-     */
-    tagName?: string;
-    /**
-     * Properties of the element to create.
-     */
-    properties?: Element['properties'];
-    /**
-     * A custom function to transform the element after it has been created.
-     */
-    transform?: (element: Element, type: DecorationTransformType) => Element | void;
-    /**
-     * By default when the decoration contains only one token, the decoration will be applied to the token.
-     *
-     * Set to `true` to always wrap the token with a new element
-     *
-     * @default false
-     */
-    alwaysWrap?: boolean;
-}
-interface ResolvedDecorationItem extends Omit<DecorationItem, 'start' | 'end'> {
-    start: ResolvedPosition;
-    end: ResolvedPosition;
-}
-type DecorationTransformType = 'wrapper' | 'line' | 'token';
-interface Position {
-    line: number;
-    character: number;
-}
-type Offset = number;
-type OffsetOrPosition = Position | Offset;
-interface ResolvedPosition extends Position {
-    offset: Offset;
-}
-
-interface HighlighterCoreOptions<Sync extends boolean = false> {
-    /**
-     * Custom RegExp engine.
-     */
-    engine?: Sync extends true ? RegexEngine : Awaitable<RegexEngine>;
-    /**
-     * Theme names, or theme registration objects to be loaded upfront.
-     */
-    themes?: Sync extends true ? MaybeArray<ThemeRegistrationAny>[] : ThemeInput[];
-    /**
-     * Language names, or language registration objects to be loaded upfront.
-     */
-    langs?: Sync extends true ? MaybeArray<LanguageRegistration>[] : LanguageInput[];
-    /**
-     * Alias of languages
-     * @example { 'my-lang': 'javascript' }
-     */
-    langAlias?: Record<string, string>;
-    /**
-     * Emit console warnings to alert users of potential issues.
-     * @default true
-     */
-    warnings?: boolean;
-    /**
-     * Load wasm file from a custom path or using a custom function.
-     */
-    loadWasm?: Sync extends true ? never : LoadWasmOptions;
-}
-interface BundledHighlighterOptions<L extends string, T extends string> extends Pick<HighlighterCoreOptions, 'warnings' | 'engine'> {
-    /**
-     * Theme registation
-     *
-     * @default []
-     */
-    themes: (ThemeInput | StringLiteralUnion<T> | SpecialTheme)[];
-    /**
-     * Language registation
-     *
-     * @default []
-     */
-    langs: (LanguageInput | StringLiteralUnion<L> | SpecialLanguage)[];
-    /**
-     * Alias of languages
-     * @example { 'my-lang': 'javascript' }
-     */
-    langAlias?: Record<string, StringLiteralUnion<L>>;
-}
-interface CodeOptionsSingleTheme<Themes extends string = string> {
-    theme: ThemeRegistrationAny | StringLiteralUnion<Themes>;
-}
-interface CodeOptionsMultipleThemes<Themes extends string = string> {
-    /**
-     * A map of color names to themes.
-     * This allows you to specify multiple themes for the generated code.
-     *
-     * ```ts
-     * highlighter.codeToHtml(code, {
-     *   lang: 'js',
-     *   themes: {
-     *     light: 'vitesse-light',
-     *     dark: 'vitesse-dark',
-     *   }
-     * })
-     * ```
-     *
-     * Will generate:
-     *
-     * ```html
-     * <span style="color:#111;--shiki-dark:#fff;">code</span>
-     * ```
-     *
-     * @see https://github.com/shikijs/shiki#lightdark-dual-themes
-     */
-    themes: Partial<Record<string, ThemeRegistrationAny | StringLiteralUnion<Themes>>>;
-    /**
-     * The default theme applied to the code (via inline `color` style).
-     * The rest of the themes are applied via CSS variables, and toggled by CSS overrides.
-     *
-     * For example, if `defaultColor` is `light`, then `light` theme is applied to the code,
-     * and the `dark` theme and other custom themes are applied via CSS variables:
-     *
-     * ```html
-     * <span style="color:#{light};--shiki-dark:#{dark};--shiki-custom:#{custom};">code</span>
-     * ```
-     *
-     * When set to `false`, no default styles will be applied, and totally up to users to apply the styles:
-     *
-     * ```html
-     * <span style="--shiki-light:#{light};--shiki-dark:#{dark};--shiki-custom:#{custom};">code</span>
-     * ```
-     *
-     *
-     * @default 'light'
-     */
-    defaultColor?: StringLiteralUnion<'light' | 'dark'> | false;
-    /**
-     * Prefix of CSS variables used to store the color of the other theme.
-     *
-     * @default '--shiki-'
-     */
-    cssVariablePrefix?: string;
-}
-type CodeOptionsThemes<Themes extends string = string> = CodeOptionsSingleTheme<Themes> | CodeOptionsMultipleThemes<Themes>;
-type CodeToHastOptions<Languages extends string = string, Themes extends string = string> = CodeToHastOptionsCommon<Languages> & CodeOptionsThemes<Themes> & CodeOptionsMeta;
-interface CodeToHastOptionsCommon<Languages extends string = string> extends TransformerOptions, DecorationOptions, Pick<TokenizeWithThemeOptions, 'colorReplacements' | 'tokenizeMaxLineLength' | 'tokenizeTimeLimit' | 'grammarState' | 'grammarContextCode'> {
-    lang: StringLiteralUnion<Languages | SpecialLanguage>;
-    /**
-     * Merge whitespace tokens to saving extra `<span>`.
-     *
-     * When set to true, it will merge whitespace tokens with the next token.
-     * When set to false, it keep the output as-is.
-     * When set to `never`, it will force to separate leading and trailing spaces from tokens.
-     *
-     * @default true
-     */
-    mergeWhitespaces?: boolean | 'never';
-    /**
-     * The structure of the generated HAST and HTML.
-     *
-     * - `classic`: The classic structure with `<pre>` and `<code>` elements, each line wrapped with a `<span class="line">` element.
-     * - `inline`: All tokens are rendered as `<span>`, line breaks are rendered as `<br>`. No `<pre>` or `<code>` elements. Default forground and background colors are not applied.
-     *
-     * @default 'classic'
-     */
-    structure?: 'classic' | 'inline';
-}
-interface CodeOptionsMeta {
-    /**
-     * Meta data passed to Shiki, usually used by plugin integrations to pass the code block header.
-     *
-     * Key values in meta will be serialized to the attributes of the root `<pre>` element.
-     *
-     * Keys starting with `_` will be ignored.
-     *
-     * A special key `__raw` key will be used to pass the raw code block header (if the integration supports it).
+ */
+declare class GrammarState {
+    private readonly _stack;
+    readonly lang: string;
+    readonly theme: string;
+    /**
+     * Static method to create a initial grammar state.
      */
-    meta?: {
-        /**
-         * Raw string of the code block header.
-         */
-        __raw?: string;
-        [key: string]: any;
+    static initial(lang: string, theme: string): GrammarState;
+    constructor(_stack: StateStack, lang: string, theme: string);
+    get scopes(): string[];
+    toJSON(): {
+        lang: string;
+        theme: string;
+        scopes: string[];
     };
 }
-interface CodeToHastRenderOptionsCommon extends TransformerOptions, Omit<TokensResult, 'tokens'> {
-    lang?: string;
-    langId?: string;
-}
-type CodeToHastRenderOptions = CodeToHastRenderOptionsCommon & CodeToHastOptions;
 
 interface CodeToTokensBaseOptions<Languages extends string = string, Themes extends string = string> extends TokenizeWithThemeOptions {
     lang?: Languages | SpecialLanguage;
@@ -651,6 +420,237 @@ declare enum FontStyle {
     Underline = 4
 }
 
+interface TransformerOptions {
+    /**
+     * Transformers for the Shiki pipeline.
+     */
+    transformers?: ShikiTransformer[];
+}
+interface ShikiTransformerContextMeta {
+}
+/**
+ * Common transformer context for all transformers hooks
+ */
+interface ShikiTransformerContextCommon {
+    meta: ShikiTransformerContextMeta;
+    options: CodeToHastOptions;
+    codeToHast: (code: string, options: CodeToHastOptions) => Root;
+    codeToTokens: (code: string, options: CodeToTokensOptions) => TokensResult;
+}
+interface ShikiTransformerContextSource extends ShikiTransformerContextCommon {
+    readonly source: string;
+}
+/**
+ * Transformer context for HAST related hooks
+ */
+interface ShikiTransformerContext extends ShikiTransformerContextSource {
+    readonly tokens: ThemedToken[][];
+    readonly root: Root;
+    readonly pre: Element;
+    readonly code: Element;
+    readonly lines: Element[];
+    readonly structure: CodeToHastOptions['structure'];
+    /**
+     * 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.
+     */
+    addClassToHast: (hast: Element, className: string | string[]) => Element;
+}
+interface ShikiTransformer {
+    /**
+     * Name of the transformer
+     */
+    name?: string;
+    /**
+     * Transform the raw input code before passing to the highlighter.
+     */
+    preprocess?: (this: ShikiTransformerContextCommon, code: string, options: CodeToHastOptions) => string | void;
+    /**
+     * Transform the full tokens list before converting to HAST.
+     * Return a new tokens list will replace the original one.
+     */
+    tokens?: (this: ShikiTransformerContextSource, tokens: ThemedToken[][]) => ThemedToken[][] | void;
+    /**
+     * Transform the entire generated HAST tree. Return a new Node will replace the original one.
+     */
+    root?: (this: ShikiTransformerContext, hast: Root) => Root | void;
+    /**
+     * Transform the `<pre>` element. Return a new Node will replace the original one.
+     */
+    pre?: (this: ShikiTransformerContext, hast: Element) => Element | void;
+    /**
+     * Transform the `<code>` element. Return a new Node will replace the original one.
+     */
+    code?: (this: ShikiTransformerContext, hast: Element) => Element | void;
+    /**
+     * Transform each line `<span class="line">` element.
+     *
+     * @param hast
+     * @param line 1-based line number
+     */
+    line?: (this: ShikiTransformerContext, hast: Element, line: number) => Element | void;
+    /**
+     * Transform each token `<span>` element.
+     */
+    span?: (this: ShikiTransformerContext, hast: Element, line: number, col: number, lineElement: Element) => Element | void;
+    /**
+     * Transform the generated HTML string before returning.
+     * This hook will only be called with `codeToHtml`.
+     */
+    postprocess?: (this: ShikiTransformerContextCommon, html: string, options: CodeToHastOptions) => string | void;
+}
+
+interface HighlighterCoreOptions<Sync extends boolean = false> {
+    /**
+     * Custom RegExp engine.
+     */
+    engine?: Sync extends true ? RegexEngine : Awaitable<RegexEngine>;
+    /**
+     * Theme names, or theme registration objects to be loaded upfront.
+     */
+    themes?: Sync extends true ? MaybeArray<ThemeRegistrationAny>[] : ThemeInput[];
+    /**
+     * Language names, or language registration objects to be loaded upfront.
+     */
+    langs?: Sync extends true ? MaybeArray<LanguageRegistration>[] : LanguageInput[];
+    /**
+     * Alias of languages
+     * @example { 'my-lang': 'javascript' }
+     */
+    langAlias?: Record<string, string>;
+    /**
+     * Emit console warnings to alert users of potential issues.
+     * @default true
+     */
+    warnings?: boolean;
+    /**
+     * Load wasm file from a custom path or using a custom function.
+     */
+    loadWasm?: Sync extends true ? never : LoadWasmOptions;
+}
+interface BundledHighlighterOptions<L extends string, T extends string> extends Pick<HighlighterCoreOptions, 'warnings' | 'engine'> {
+    /**
+     * Theme registation
+     *
+     * @default []
+     */
+    themes: (ThemeInput | StringLiteralUnion<T> | SpecialTheme)[];
+    /**
+     * Language registation
+     *
+     * @default []
+     */
+    langs: (LanguageInput | StringLiteralUnion<L> | SpecialLanguage)[];
+    /**
+     * Alias of languages
+     * @example { 'my-lang': 'javascript' }
+     */
+    langAlias?: Record<string, StringLiteralUnion<L>>;
+}
+interface CodeOptionsSingleTheme<Themes extends string = string> {
+    theme: ThemeRegistrationAny | StringLiteralUnion<Themes>;
+}
+interface CodeOptionsMultipleThemes<Themes extends string = string> {
+    /**
+     * A map of color names to themes.
+     * This allows you to specify multiple themes for the generated code.
+     *
+     * ```ts
+     * highlighter.codeToHtml(code, {
+     *   lang: 'js',
+     *   themes: {
+     *     light: 'vitesse-light',
+     *     dark: 'vitesse-dark',
+     *   }
+     * })
+     * ```
+     *
+     * Will generate:
+     *
+     * ```html
+     * <span style="color:#111;--shiki-dark:#fff;">code</span>
+     * ```
+     *
+     * @see https://github.com/shikijs/shiki#lightdark-dual-themes
+     */
+    themes: Partial<Record<string, ThemeRegistrationAny | StringLiteralUnion<Themes>>>;
+    /**
+     * The default theme applied to the code (via inline `color` style).
+     * The rest of the themes are applied via CSS variables, and toggled by CSS overrides.
+     *
+     * For example, if `defaultColor` is `light`, then `light` theme is applied to the code,
+     * and the `dark` theme and other custom themes are applied via CSS variables:
+     *
+     * ```html
+     * <span style="color:#{light};--shiki-dark:#{dark};--shiki-custom:#{custom};">code</span>
+     * ```
+     *
+     * When set to `false`, no default styles will be applied, and totally up to users to apply the styles:
+     *
+     * ```html
+     * <span style="--shiki-light:#{light};--shiki-dark:#{dark};--shiki-custom:#{custom};">code</span>
+     * ```
+     *
+     *
+     * @default 'light'
+     */
+    defaultColor?: StringLiteralUnion<'light' | 'dark'> | false;
+    /**
+     * Prefix of CSS variables used to store the color of the other theme.
+     *
+     * @default '--shiki-'
+     */
+    cssVariablePrefix?: string;
+}
+type CodeOptionsThemes<Themes extends string = string> = CodeOptionsSingleTheme<Themes> | CodeOptionsMultipleThemes<Themes>;
+type CodeToHastOptions<Languages extends string = string, Themes extends string = string> = CodeToHastOptionsCommon<Languages> & CodeOptionsThemes<Themes> & CodeOptionsMeta;
+interface CodeToHastOptionsCommon<Languages extends string = string> extends TransformerOptions, DecorationOptions, Pick<TokenizeWithThemeOptions, 'colorReplacements' | 'tokenizeMaxLineLength' | 'tokenizeTimeLimit' | 'grammarState' | 'grammarContextCode'> {
+    lang: StringLiteralUnion<Languages | SpecialLanguage>;
+    /**
+     * Merge whitespace tokens to saving extra `<span>`.
+     *
+     * When set to true, it will merge whitespace tokens with the next token.
+     * When set to false, it keep the output as-is.
+     * When set to `never`, it will force to separate leading and trailing spaces from tokens.
+     *
+     * @default true
+     */
+    mergeWhitespaces?: boolean | 'never';
+    /**
+     * The structure of the generated HAST and HTML.
+     *
+     * - `classic`: The classic structure with `<pre>` and `<code>` elements, each line wrapped with a `<span class="line">` element.
+     * - `inline`: All tokens are rendered as `<span>`, line breaks are rendered as `<br>`. No `<pre>` or `<code>` elements. Default forground and background colors are not applied.
+     *
+     * @default 'classic'
+     */
+    structure?: 'classic' | 'inline';
+}
+interface CodeOptionsMeta {
+    /**
+     * Meta data passed to Shiki, usually used by plugin integrations to pass the code block header.
+     *
+     * Key values in meta will be serialized to the attributes of the root `<pre>` element.
+     *
+     * Keys starting with `_` will be ignored.
+     *
+     * A special key `__raw` key will be used to pass the raw code block header (if the integration supports it).
+     */
+    meta?: {
+        /**
+         * Raw string of the code block header.
+         */
+        __raw?: string;
+        [key: string]: any;
+    };
+}
+interface CodeToHastRenderOptionsCommon extends TransformerOptions, Omit<TokensResult, 'tokens'> {
+    lang?: string;
+    langId?: string;
+}
+type CodeToHastRenderOptions = CodeToHastRenderOptionsCommon & CodeToHastOptions;
+
 /**
  * Internal context of Shiki, core textmate logic
  */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@shikijs/core",
   "type": "module",
-  "version": "1.16.2",
+  "version": "1.16.3",
   "description": "Core of Shiki",
   "author": "Pine Wu <octref@gmail.com>; Anthony Fu <anthonyfu117@hotmail.com>",
   "license": "MIT",
@@ -61,11 +61,12 @@
   ],
   "dependencies": {
     "@shikijs/vscode-textmate": "^9.2.0",
-    "@types/hast": "^3.0.4"
+    "@types/hast": "^3.0.4",
+    "oniguruma-to-js": "0.3.3",
+    "regex": "4.3.2"
   },
   "devDependencies": {
     "hast-util-to-html": "^9.0.2",
-    "oniguruma-to-js": "^0.3.1",
     "vscode-oniguruma": "^1.7.0"
   },
   "scripts": {