@shikijs/twoslash 3.22.0 → 4.0.0

package/dist/core.d.mts

@@ -1,308 +1,313 @@
-import { CodeToHastOptions, ShikiTransformerContextCommon, ShikiTransformerContext, ShikiTransformerContextMeta, ShikiTransformer } from '@shikijs/types';
-import { TwoslashReturn, TwoslashExecuteOptions, TwoslashGenericFunction, TwoslashOptions, NodeError, NodeTag, NodeQuery, NodeCompletion, NodeHover, NodeHighlight } from 'twoslash';
-import { ElementContent, Element, Text } from 'hast';
+import { NodeCompletion, NodeError, NodeHighlight, NodeHover, NodeQuery, NodeTag, TwoslashExecuteOptions, TwoslashGenericFunction, TwoslashOptions, TwoslashReturn } from "twoslash";
+import { CodeToHastOptions, ShikiTransformer, ShikiTransformerContext, ShikiTransformerContextCommon, ShikiTransformerContextMeta } from "@shikijs/types";
+import { Element, ElementContent, Text } from "hast";
 
+//#region src/types.d.ts
 type TwoslashShikiReturn = Pick<TwoslashReturn, 'nodes' | 'code'> & {
-    meta?: Partial<Pick<TwoslashReturn['meta'], 'extension'>>;
+  meta?: Partial<Pick<TwoslashReturn['meta'], 'extension'>>;
 };
 type TwoslashShikiFunction = (code: string, lang?: string, options?: TwoslashExecuteOptions) => TwoslashShikiReturn;
 declare module '@shikijs/core' {
-    interface ShikiTransformerContextMeta {
-        twoslash?: TwoslashShikiReturn;
-    }
+  interface ShikiTransformerContextMeta {
+    twoslash?: TwoslashShikiReturn;
+  }
 }
 interface TwoslashTypesCache {
-    /**
-     * On initialization
-     */
-    init?: () => void;
-    preprocess?: (code: string, lang?: string, options?: TwoslashExecuteOptions, meta?: ShikiTransformerContextMeta) => string | void;
-    /**
-     * Read cached result
-     *
-     * @param code Source code
-     */
-    read: (code: string, lang?: string, options?: TwoslashExecuteOptions, meta?: ShikiTransformerContextMeta) => TwoslashShikiReturn | null;
-    /**
-     * Save result to cache
-     *
-     * @param code Source code
-     * @param data Twoslash data
-     */
-    write: (code: string, data: TwoslashShikiReturn, lang?: string, options?: TwoslashExecuteOptions, meta?: ShikiTransformerContextMeta) => void;
+  /**
+   * On initialization
+   */
+  init?: () => void;
+  preprocess?: (code: string, lang?: string, options?: TwoslashExecuteOptions, meta?: ShikiTransformerContextMeta) => string | void;
+  /**
+   * Read cached result
+   *
+   * @param code Source code
+   */
+  read: (code: string, lang?: string, options?: TwoslashExecuteOptions, meta?: ShikiTransformerContextMeta) => TwoslashShikiReturn | null;
+  /**
+   * Save result to cache
+   *
+   * @param code Source code
+   * @param data Twoslash data
+   */
+  write: (code: string, data: TwoslashShikiReturn, lang?: string, options?: TwoslashExecuteOptions, meta?: ShikiTransformerContextMeta) => void;
 }
 interface TransformerTwoslashOptions {
-    /**
-     * Languages to apply this transformer to
-     */
-    langs?: string[];
-    /**
-     * Requires `twoslash` to be presented in the code block meta to apply this transformer
-     *
-     * @default false
-     */
-    explicitTrigger?: boolean | RegExp;
-    /**
-     * Triggers that skip Twoslash transformation on the code block meta
-     *
-     * @default ['notwoslash', 'no-twoslash']
-     */
-    disableTriggers?: (string | RegExp)[];
-    /**
-     * Mapping from language alias to language name
-     */
-    langAlias?: Record<string, string>;
-    /**
-     * Custom filter function to apply this transformer to
-     * When specified, `langs`, `explicitTrigger`, and `disableTriggers` will be ignored
-     */
-    filter?: (lang: string, code: string, options: CodeToHastOptions, context?: ShikiTransformerContextCommon) => boolean;
-    /**
-     * Custom instance of twoslasher function
-     */
-    twoslasher?: TwoslashShikiFunction | TwoslashGenericFunction;
-    /**
-     * Options to pass to twoslash
-     */
-    twoslashOptions?: TwoslashOptions;
-    /**
-     * Custom renderers to decide how each info should be rendered
-     */
-    renderer?: TwoslashRenderer;
-    /**
-     * A map to store code for `@include` directive
-     * Provide your own instance if you want to clear the map between each transformation
-     */
-    includesMap?: Map<string, string>;
-    /**
-     * Strictly throw when there is an error
-     * @default true
-     */
-    throws?: boolean;
-    /**
-     * Custom error handler for twoslash errors
-     * When specified, `throws` will be ignored
-     * Optionally return a string to replace the code
-     */
-    onTwoslashError?: (error: unknown, code: string, lang: string, options: CodeToHastOptions) => string | void;
-    /**
-     * Custom error handler for Shiki errors
-     * When specified, `throws` will be ignored
-     */
-    onShikiError?: (error: unknown, code: string, lang: string) => void;
-    /**
-     * The options for caching resolved types
-     *
-     * @example
-     * ```ts
-     * import { transformerTwoslash } from '@shikijs/vitepress-twoslash'
-     * import { createFileSystemTypesCache } from '@shikijs/vitepress-twoslash/cache-fs'
-     *
-     * transformerTwoslash({
-     *   typesCache: createFileSystemTypesCache({
-     *     dir: './my-cache-dir'
-     *   })
-     * })
-     * ```
-     */
-    typesCache?: TwoslashTypesCache;
+  /**
+   * Languages to apply this transformer to
+   */
+  langs?: string[];
+  /**
+   * Requires `twoslash` to be presented in the code block meta to apply this transformer
+   *
+   * @default false
+   */
+  explicitTrigger?: boolean | RegExp;
+  /**
+   * Triggers that skip Twoslash transformation on the code block meta
+   *
+   * @default ['notwoslash', 'no-twoslash']
+   */
+  disableTriggers?: (string | RegExp)[];
+  /**
+   * Mapping from language alias to language name
+   */
+  langAlias?: Record<string, string>;
+  /**
+   * Custom filter function to apply this transformer to
+   * When specified, `langs`, `explicitTrigger`, and `disableTriggers` will be ignored
+   */
+  filter?: (lang: string, code: string, options: CodeToHastOptions, context?: ShikiTransformerContextCommon) => boolean;
+  /**
+   * Custom instance of twoslasher function
+   */
+  twoslasher?: TwoslashShikiFunction | TwoslashGenericFunction;
+  /**
+   * Options to pass to twoslash
+   */
+  twoslashOptions?: TwoslashOptions;
+  /**
+   * Custom renderers to decide how each info should be rendered
+   */
+  renderer?: TwoslashRenderer;
+  /**
+   * A map to store code for `@include` directive
+   * Provide your own instance if you want to clear the map between each transformation
+   */
+  includesMap?: Map<string, string>;
+  /**
+   * Strictly throw when there is an error
+   * @default true
+   */
+  throws?: boolean;
+  /**
+   * Custom error handler for twoslash errors
+   * When specified, `throws` will be ignored
+   * Optionally return a string to replace the code
+   */
+  onTwoslashError?: (error: unknown, code: string, lang: string, options: CodeToHastOptions) => string | void;
+  /**
+   * Custom error handler for Shiki errors
+   * When specified, `throws` will be ignored
+   */
+  onShikiError?: (error: unknown, code: string, lang: string) => void;
+  /**
+   * The options for caching resolved types
+   *
+   * @example
+   * ```ts
+   * import { transformerTwoslash } from '@shikijs/vitepress-twoslash'
+   * import { createFileSystemTypesCache } from '@shikijs/vitepress-twoslash/cache-fs'
+   *
+   * transformerTwoslash({
+   *   typesCache: createFileSystemTypesCache({
+   *     dir: './my-cache-dir'
+   *   })
+   * })
+   * ```
+   */
+  typesCache?: TwoslashTypesCache;
 }
 interface TwoslashRenderer {
-    lineError?: (this: ShikiTransformerContext, error: NodeError) => ElementContent[];
-    lineCustomTag?: (this: ShikiTransformerContext, tag: NodeTag) => ElementContent[];
-    lineQuery?: (this: ShikiTransformerContext, query: NodeQuery, targetNode?: Element | Text) => ElementContent[];
-    lineCompletion?: (this: ShikiTransformerContext, query: NodeCompletion) => ElementContent[];
-    nodeStaticInfo: (this: ShikiTransformerContext, info: NodeHover, node: Element | Text) => Partial<ElementContent>;
-    nodeError?: (this: ShikiTransformerContext, error: NodeError, node: Element | Text) => Partial<ElementContent>;
-    nodeQuery?: (this: ShikiTransformerContext, query: NodeQuery, node: Element | Text) => Partial<ElementContent>;
-    nodeCompletion?: (this: ShikiTransformerContext, query: NodeCompletion, node: Element | Text) => Partial<ElementContent>;
-    nodesError?: (this: ShikiTransformerContext, error: NodeError, nodes: ElementContent[]) => ElementContent[];
-    nodesHighlight?: (this: ShikiTransformerContext, highlight: NodeHighlight, nodes: ElementContent[]) => ElementContent[];
+  lineError?: (this: ShikiTransformerContext, error: NodeError) => ElementContent[];
+  lineCustomTag?: (this: ShikiTransformerContext, tag: NodeTag) => ElementContent[];
+  lineQuery?: (this: ShikiTransformerContext, query: NodeQuery, targetNode?: Element | Text) => ElementContent[];
+  lineCompletion?: (this: ShikiTransformerContext, query: NodeCompletion) => ElementContent[];
+  nodeStaticInfo: (this: ShikiTransformerContext, info: NodeHover, node: Element | Text) => Partial<ElementContent>;
+  nodeError?: (this: ShikiTransformerContext, error: NodeError, node: Element | Text) => Partial<ElementContent>;
+  nodeQuery?: (this: ShikiTransformerContext, query: NodeQuery, node: Element | Text) => Partial<ElementContent>;
+  nodeCompletion?: (this: ShikiTransformerContext, query: NodeCompletion, node: Element | Text) => Partial<ElementContent>;
+  nodesError?: (this: ShikiTransformerContext, error: NodeError, nodes: ElementContent[]) => ElementContent[];
+  nodesHighlight?: (this: ShikiTransformerContext, highlight: NodeHighlight, nodes: ElementContent[]) => ElementContent[];
 }
-
+//#endregion
+//#region src/error.d.ts
 declare class ShikiTwoslashError extends Error {
-    constructor(message: string);
+  constructor(message: string);
 }
-
+//#endregion
+//#region src/icons.d.ts
 type CompletionItem = NonNullable<NodeCompletion['completions']>[number];
 declare const defaultCompletionIcons: Record<string, Element | undefined>;
 declare const defaultCustomTagIcons: Record<string, Element | undefined>;
-
+//#endregion
+//#region src/renderer-classic.d.ts
 /**
  * The default renderer aligning with the original `@shikijs/twoslash` output.
  */
 declare function rendererClassic(): TwoslashRenderer;
-
+//#endregion
+//#region src/renderer-rich.d.ts
 interface RendererRichOptions {
+  /**
+   * Render JSDoc comments in hover popup.
+   *
+   * @default true
+   */
+  jsdoc?: boolean;
+  /**
+   * Custom icons for completion items.
+   * A map from completion item kind to a HAST node.
+   *
+   * If `false`, no icons will be rendered.
+   * @default defaultCompletionIcons
+   */
+  completionIcons?: Partial<Record<string, ElementContent>> | false;
+  /**
+   * Custom icons for custom tags lines.
+   * A map from tag name to a HAST node.
+   *
+   * If `false`, no icons will be rendered.
+   * @default defaultCustomTagIcons
+   */
+  customTagIcons?: Partial<Record<string, ElementContent>> | false;
+  /**
+   * Custom formatter for the type info text.
+   * Note that it might not be valid TypeScript syntax.
+   *
+   * @default defaultHoverInfoProcessor
+   */
+  processHoverInfo?: (info: string) => string;
+  /**
+   * Custom formatter for the docs text (can be markdown).
+   *
+   * @default undefined
+   */
+  processHoverDocs?: (docs: string) => string;
+  /**
+   * The way errors should be rendered.
+   *
+   * - `'line'`: Render the error line after the line of code
+   * - `'hover'`: Render the error in the hover popup
+   *
+   * @default 'line'
+   */
+  errorRendering?: 'line' | 'hover';
+  /**
+   * Classes added to injected elements
+   */
+  classExtra?: string;
+  /**
+   * Language for syntax highlight.
+   * @default the language of the code block
+   */
+  lang?: string;
+  /**
+   * Custom function to render markdown.
+   *
+   * By default it pass-through the markdown.
+   */
+  renderMarkdown?: (this: ShikiTransformerContextCommon, markdown: string) => ElementContent[];
+  /**
+   * Custom function to render inline markdown.
+   *
+   * By default it pass-through the markdown.
+   */
+  renderMarkdownInline?: (this: ShikiTransformerContextCommon, markdown: string, context: string) => ElementContent[];
+  /**
+   * The way query should be rendered.
+   * - `'popup'`: Render the query in the absolute popup
+   * - `'line'`: Render the query line after the line of code
+   * @default 'popup'
+   */
+  queryRendering?: 'popup' | 'line';
+  /**
+   * Extensions for the generated HAST tree.
+   */
+  hast?: {
+    /**
+     * The <code> block for in the hover popup.
+     */
+    popupTypes?: HastExtension;
+    /**
+     * The documentation block in the hover popup. Can be markdown rendered if `renderMarkdown` is provided.
+     */
+    popupDocs?: HastExtension;
     /**
-     * Render JSDoc comments in hover popup.
-     *
-     * @default true
+     * The container of jsdoc tags in the hover popup.
      */
-    jsdoc?: boolean;
+    popupDocsTags?: HastExtension;
     /**
-     * Custom icons for completion items.
-     * A map from completion item kind to a HAST node.
-     *
-     * If `false`, no icons will be rendered.
-     * @default defaultCompletionIcons
+     * The token for the hover informaton.
      */
-    completionIcons?: Partial<Record<string, ElementContent>> | false;
+    hoverToken?: HastExtension;
     /**
-     * Custom icons for custom tags lines.
-     * A map from tag name to a HAST node.
-     *
-     * If `false`, no icons will be rendered.
-     * @default defaultCustomTagIcons
+     * The container of the hover popup.
      */
-    customTagIcons?: Partial<Record<string, ElementContent>> | false;
+    hoverPopup?: HastExtension;
     /**
-     * Custom formatter for the type info text.
-     * Note that it might not be valid TypeScript syntax.
-     *
-     * @default defaultHoverInfoProcessor
+     * The container of error popup.
      */
-    processHoverInfo?: (info: string) => string;
+    popupError?: HastExtension;
     /**
-     * Custom formatter for the docs text (can be markdown).
-     *
-     * @default undefined
+     * Custom function to compose the hover token.
      */
-    processHoverDocs?: (docs: string) => string;
+    hoverCompose?: (parts: {
+      popup: Element;
+      token: Text | Element;
+    }) => ElementContent[];
     /**
-     * The way errors should be rendered.
-     *
-     * - `'line'`: Render the error line after the line of code
-     * - `'hover'`: Render the error in the hover popup
-     *
-     * @default 'line'
+     * The token for the query informaton.
      */
-    errorRendering?: 'line' | 'hover';
+    queryToken?: HastExtension;
     /**
-     * Classes added to injected elements
+     * The container of the query popup.
      */
-    classExtra?: string;
+    queryPopup?: HastExtension;
     /**
-     * Language for syntax highlight.
-     * @default the language of the code block
+     * Custom function to compose the hover token.
      */
-    lang?: string;
+    queryCompose?: (parts: {
+      popup: Element;
+      token: Text | Element;
+    }) => ElementContent[];
     /**
-     * Custom function to render markdown.
-     *
-     * By default it pass-through the markdown.
+     * The token for the completion informaton.
      */
-    renderMarkdown?: (this: ShikiTransformerContextCommon, markdown: string) => ElementContent[];
+    completionToken?: HastExtension;
     /**
-     * Custom function to render inline markdown.
-     *
-     * By default it pass-through the markdown.
+     * The cursor element in the completion popup.
      */
-    renderMarkdownInline?: (this: ShikiTransformerContextCommon, markdown: string, context: string) => ElementContent[];
+    completionCursor?: HastExtension;
     /**
-     * The way query should be rendered.
-     * - `'popup'`: Render the query in the absolute popup
-     * - `'line'`: Render the query line after the line of code
-     * @default 'popup'
+     * The container of the completion popup.
      */
-    queryRendering?: 'popup' | 'line';
+    completionPopup?: HastExtension;
     /**
-     * Extensions for the generated HAST tree.
+     * Custom function to compose the completion token.
      */
-    hast?: {
-        /**
-         * The <code> block for in the hover popup.
-         */
-        popupTypes?: HastExtension;
-        /**
-         * The documentation block in the hover popup. Can be markdown rendered if `renderMarkdown` is provided.
-         */
-        popupDocs?: HastExtension;
-        /**
-         * The container of jsdoc tags in the hover popup.
-         */
-        popupDocsTags?: HastExtension;
-        /**
-         * The token for the hover informaton.
-         */
-        hoverToken?: HastExtension;
-        /**
-         * The container of the hover popup.
-         */
-        hoverPopup?: HastExtension;
-        /**
-         * The container of error popup.
-         */
-        popupError?: HastExtension;
-        /**
-         * Custom function to compose the hover token.
-         */
-        hoverCompose?: (parts: {
-            popup: Element;
-            token: Text | Element;
-        }) => ElementContent[];
-        /**
-         * The token for the query informaton.
-         */
-        queryToken?: HastExtension;
-        /**
-         * The container of the query popup.
-         */
-        queryPopup?: HastExtension;
-        /**
-         * Custom function to compose the hover token.
-         */
-        queryCompose?: (parts: {
-            popup: Element;
-            token: Text | Element;
-        }) => ElementContent[];
-        /**
-         * The token for the completion informaton.
-         */
-        completionToken?: HastExtension;
-        /**
-         * The cursor element in the completion popup.
-         */
-        completionCursor?: HastExtension;
-        /**
-         * The container of the completion popup.
-         */
-        completionPopup?: HastExtension;
-        /**
-         * Custom function to compose the completion token.
-         */
-        completionCompose?: (parts: {
-            popup: Element;
-            cursor: Element;
-        }) => ElementContent[];
-        /**
-         * The token for the error informaton.
-         */
-        errorToken?: HastExtension;
-        /**
-         * The container of the error popup.
-         * Only used when `errorRendering` is set to `'hover'`.
-         */
-        errorPopup?: HastExtension;
-        /**
-         * Custom function to compose the error token.
-         * Only used when `errorRendering` is set to `'hover'`.
-         */
-        errorCompose?: (parts: {
-            popup: Element;
-            token: Text | Element;
-        }) => ElementContent[];
-        /**
-         * The wrapper for the highlighted nodes.
-         */
-        nodesHighlight?: HastExtension;
-    };
+    completionCompose?: (parts: {
+      popup: Element;
+      cursor: Element;
+    }) => ElementContent[];
+    /**
+     * The token for the error informaton.
+     */
+    errorToken?: HastExtension;
+    /**
+     * The container of the error popup.
+     * Only used when `errorRendering` is set to `'hover'`.
+     */
+    errorPopup?: HastExtension;
+    /**
+     * Custom function to compose the error token.
+     * Only used when `errorRendering` is set to `'hover'`.
+     */
+    errorCompose?: (parts: {
+      popup: Element;
+      token: Text | Element;
+    }) => ElementContent[];
+    /**
+     * The wrapper for the highlighted nodes.
+     */
+    nodesHighlight?: HastExtension;
+  };
 }
 interface HastExtension {
-    tagName?: string;
-    properties?: Element['properties'];
-    class?: string;
-    children?: (input: ElementContent[]) => ElementContent[];
+  tagName?: string;
+  properties?: Element['properties'];
+  class?: string;
+  children?: (input: ElementContent[]) => ElementContent[];
 }
 /**
  * An alternative renderer that providers better prefixed class names,
@@ -313,14 +318,9 @@ declare function rendererRich(options?: RendererRichOptions): TwoslashRenderer;
  * The default hover info processor, which will do some basic cleanup
  */
 declare function defaultHoverInfoProcessor(type: string): string;
-
-/**
- * This file is the core of the @shikijs/twoslash package,
- * Decoupled from twoslash's implementation and allowing to introduce custom implementation or cache system.
- */
-
+//#endregion
+//#region src/core.d.ts
 declare function defaultTwoslashOptions(): TwoslashExecuteOptions;
 declare function createTransformerFactory(defaultTwoslasher: TwoslashShikiFunction | TwoslashGenericFunction, defaultRenderer?: TwoslashRenderer): (options?: TransformerTwoslashOptions) => ShikiTransformer;
-
-export { ShikiTwoslashError, createTransformerFactory, defaultCompletionIcons, defaultCustomTagIcons, defaultHoverInfoProcessor, defaultTwoslashOptions, rendererClassic, rendererRich };
-export type { CompletionItem, HastExtension, RendererRichOptions, TransformerTwoslashOptions, TwoslashRenderer, TwoslashShikiFunction, TwoslashShikiReturn, TwoslashTypesCache };
+//#endregion
+export { CompletionItem, HastExtension, RendererRichOptions, ShikiTwoslashError, TransformerTwoslashOptions, TwoslashRenderer, TwoslashShikiFunction, TwoslashShikiReturn, TwoslashTypesCache, createTransformerFactory, defaultCompletionIcons, defaultCustomTagIcons, defaultHoverInfoProcessor, defaultTwoslashOptions, rendererClassic, rendererRich };