@shikijs/core 1.8.0 → 1.9.1

package/dist/chunk-tokens.d.mts

@@ -1017,7 +1017,7 @@ interface BundledHighlighterOptions<L extends string, T extends string> {
      *
      * @default []
      */
-    themes: (ThemeInput | StringLiteralUnion<T>)[];
+    themes: (ThemeInput | StringLiteralUnion<T> | SpecialTheme)[];
     /**
      * Language registation
      *

package/dist/index.d.mts

@@ -10,17 +10,23 @@ export { W as WebAssemblyInstantiator, l as loadWasm } from './chunk-index.mjs';
  *
  * @see http://shiki.style/guide/install#fine-grained-bundle
  */
+declare function createHighlighterCore(options?: HighlighterCoreOptions): Promise<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>;
 
-type GetHighlighterFactory<L extends string, T extends string> = (options: BundledHighlighterOptions<L, T>) => Promise<HighlighterGeneric<L, T>>;
+type CreateHighlighterFactory<L extends string, T extends string> = (options: BundledHighlighterOptions<L, T>) => Promise<HighlighterGeneric<L, T>>;
 /**
- * Create a `getHighlighter` function with bundled themes and languages.
+ * Create a `createHighlighter` function with bundled themes and languages.
  *
  * @param bundledLanguages
  * @param bundledThemes
  * @param loadWasm
  */
-declare function createdBundledHighlighter<BundledLangs extends string, BundledThemes extends string>(bundledLanguages: Record<BundledLangs, LanguageInput>, bundledThemes: Record<BundledThemes, ThemeInput>, loadWasm: HighlighterCoreOptions['loadWasm']): GetHighlighterFactory<BundledLangs, BundledThemes>;
+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.
@@ -59,12 +65,11 @@ interface ShorthandsBundle<L extends string, T extends string> {
     codeToTokensWithThemes: (code: string, options: RequireKeys<CodeToTokensWithThemesOptions<L, T>, 'themes' | 'lang'>) => Promise<ThemedTokenWithVariants[][]>;
     /**
      * Get internal singleton highlighter.
-     *
-     * @internal
      */
-    getSingletonHighlighter: () => Promise<HighlighterGeneric<L, T>>;
+    getSingletonHighlighter: (options?: Partial<BundledHighlighterOptions<L, T>>) => Promise<HighlighterGeneric<L, T>>;
 }
-declare function createSingletonShorthands<L extends string, T extends string>(getHighlighter: GetHighlighterFactory<L, T>): ShorthandsBundle<L, T>;
+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>;
 
 declare function toArray<T>(x: MaybeArray<T>): T[];
 /**
@@ -135,6 +140,10 @@ declare function setDefaultWasmLoader(_loader: LoadWasmOptions): void;
 /**
  * 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>;
 
 /**
@@ -401,4 +410,4 @@ declare class ShikiError extends Error {
     constructor(message: string);
 }
 
-export { BundledHighlighterOptions, CodeToHastOptions, CodeToHastRenderOptions, CodeToTokensBaseOptions, CodeToTokensOptions, CodeToTokensWithThemesOptions, type GetHighlighterFactory, IGrammar as Grammar, HighlighterCore, HighlighterCoreOptions, HighlighterGeneric, LanguageInput, MaybeArray, PlainTextLanguage, Position, RequireKeys, ShikiError, ShikiInternal, ShikiTransformer, ShikiTransformerContextCommon, ShikiTransformerContextSource, type ShorthandsBundle, SpecialLanguage, SpecialTheme, ThemeInput, ThemeRegistrationAny, ThemeRegistrationResolved, ThemedToken, ThemedTokenWithVariants, TokenStyles, TokenizeWithThemeOptions, TokensResult, addClassToHast, applyColorReplacements, codeToHast, codeToHtml, codeToTokens, codeToTokensBase, codeToTokensWithThemes, createPositionConverter, createSingletonShorthands, createdBundledHighlighter, getHighlighterCore, getShikiInternal, getTokenStyleObject, toHtml as hastToHtml, isNoneTheme, isPlainLang, isSpecialLang, isSpecialTheme, normalizeTheme, resolveColorReplacements, setDefaultWasmLoader, splitLines, splitToken, splitTokens, stringifyTokenStyle, toArray, tokenizeAnsiWithTheme, tokenizeWithTheme, tokensToHast, transformerDecorations };
+export { BundledHighlighterOptions, CodeToHastOptions, CodeToHastRenderOptions, CodeToTokensBaseOptions, CodeToTokensOptions, CodeToTokensWithThemesOptions, type CreateHighlighterFactory, IGrammar as Grammar, HighlighterCore, HighlighterCoreOptions, HighlighterGeneric, LanguageInput, MaybeArray, PlainTextLanguage, Position, RequireKeys, ShikiError, ShikiInternal, ShikiTransformer, ShikiTransformerContextCommon, ShikiTransformerContextSource, type ShorthandsBundle, SpecialLanguage, SpecialTheme, ThemeInput, ThemeRegistrationAny, ThemeRegistrationResolved, ThemedToken, ThemedTokenWithVariants, TokenStyles, TokenizeWithThemeOptions, TokensResult, addClassToHast, applyColorReplacements, codeToHast, codeToHtml, codeToTokens, codeToTokensBase, codeToTokensWithThemes, createHighlighterCore, createPositionConverter, createShikiInternal, createSingletonShorthands, createdBundledHighlighter, getHighlighterCore, getShikiInternal, getSingletonHighlighterCore, getTokenStyleObject, toHtml as hastToHtml, isNoneTheme, isPlainLang, isSpecialLang, isSpecialTheme, makeSingletonHighlighter, makeSingletonHighlighterCore, normalizeTheme, resolveColorReplacements, setDefaultWasmLoader, splitLines, splitToken, splitTokens, stringifyTokenStyle, toArray, tokenizeAnsiWithTheme, tokenizeWithTheme, tokensToHast, transformerDecorations };

package/dist/index.mjs

@@ -5399,7 +5399,7 @@ let instancesCount = 0;
 /**
  * Get the minimal shiki context for rendering.
  */
-async function getShikiInternal(options = {}) {
+async function createShikiInternal(options = {}) {
     instancesCount += 1;
     if (options.warnings !== false && instancesCount >= 10 && instancesCount % 10 === 0)
         console.warn(`[Shiki] ${instancesCount} instances have been created. Shiki is supposed to be used as a singleton, consider refactoring your code to cache your highlighter instance; Or call \`highlighter.dispose()\` to release unused instances.`);
@@ -5499,6 +5499,13 @@ async function getShikiInternal(options = {}) {
         [Symbol.dispose]: dispose,
     };
 }
+/**
+ * @deprecated Use `createShikiInternal` instead.
+ */
+function getShikiInternal(options = {}) {
+    // TODO: next: console.warn('`getShikiInternal` is deprecated. Use `createShikiInternal` instead.')
+    return createShikiInternal(options);
+}
 
 /**
  * Create a Shiki core highlighter instance, with no languages or themes bundled.
@@ -5506,8 +5513,8 @@ async function getShikiInternal(options = {}) {
  *
  * @see http://shiki.style/guide/install#fine-grained-bundle
  */
-async function getHighlighterCore(options = {}) {
-    const internal = await getShikiInternal(options);
+async function createHighlighterCore(options = {}) {
+    const internal = await createShikiInternal(options);
     return {
         codeToTokensBase: (code, options) => codeToTokensBase(internal, code, options),
         codeToTokensWithThemes: (code, options) => codeToTokensWithThemes(internal, code, options),
@@ -5518,16 +5525,47 @@ async function getHighlighterCore(options = {}) {
         getInternalContext: () => internal,
     };
 }
+function makeSingletonHighlighterCore(createHighlighter) {
+    let _shiki;
+    async function getSingletonHighlighterCore(options = {}) {
+        if (!_shiki) {
+            _shiki = createHighlighter({
+                ...options,
+                themes: options.themes || [],
+                langs: options.langs || [],
+            });
+            return _shiki;
+        }
+        else {
+            const s = await _shiki;
+            await Promise.all([
+                s.loadTheme(...(options.themes || [])),
+                s.loadLanguage(...(options.langs || [])),
+            ]);
+            return s;
+        }
+    }
+    return getSingletonHighlighterCore;
+}
+const getSingletonHighlighterCore = /* @__PURE__ */ makeSingletonHighlighterCore(createHighlighterCore);
+/**
+ * @deprecated Use `createHighlighterCore` or `getSingletonHighlighterCore` instead.
+ */
+/* v8 ignore next 5 */
+function getHighlighterCore(options = {}) {
+    // TODO: next:  console.warn('`getHighlighterCore` is deprecated. Use `createHighlighterCore` or `getSingletonHighlighterCore` instead.')
+    return createHighlighterCore(options);
+}
 
 /**
- * Create a `getHighlighter` function with bundled themes and languages.
+ * Create a `createHighlighter` function with bundled themes and languages.
  *
  * @param bundledLanguages
  * @param bundledThemes
  * @param loadWasm
  */
 function createdBundledHighlighter(bundledLanguages, bundledThemes, loadWasm) {
-    async function getHighlighter(options) {
+    async function createHighlighter(options) {
         function resolveLang(lang) {
             if (typeof lang === 'string') {
                 if (isSpecialLang(lang))
@@ -5553,7 +5591,7 @@ function createdBundledHighlighter(bundledLanguages, bundledThemes, loadWasm) {
         const _themes = (options.themes ?? []).map(i => resolveTheme(i));
         const langs = (options.langs ?? [])
             .map(i => resolveLang(i));
-        const core = await getHighlighterCore({
+        const core = await createHighlighterCore({
             ...options,
             themes: _themes,
             langs,
@@ -5569,62 +5607,72 @@ function createdBundledHighlighter(bundledLanguages, bundledThemes, loadWasm) {
             },
         };
     }
-    return getHighlighter;
+    return createHighlighter;
 }
-function createSingletonShorthands(getHighlighter) {
+function makeSingletonHighlighter(createHighlighter) {
     let _shiki;
-    async function _getHighlighter(options = {}) {
+    async function getSingletonHighlighter(options = {}) {
         if (!_shiki) {
-            _shiki = getHighlighter({
-                themes: toArray(options.theme || []),
-                langs: toArray(options.lang || []),
+            _shiki = createHighlighter({
+                ...options,
+                themes: options.themes || [],
+                langs: options.langs || [],
             });
             return _shiki;
         }
         else {
             const s = await _shiki;
             await Promise.all([
-                s.loadTheme(...toArray(options.theme || [])),
-                s.loadLanguage(...toArray(options.lang || [])),
+                s.loadTheme(...(options.themes || [])),
+                s.loadLanguage(...(options.langs || [])),
             ]);
             return s;
         }
     }
+    return getSingletonHighlighter;
+}
+function createSingletonShorthands(createHighlighter) {
+    const getSingletonHighlighter = makeSingletonHighlighter(createHighlighter);
     return {
-        getSingletonHighlighter: () => _getHighlighter(),
+        getSingletonHighlighter(options) {
+            return getSingletonHighlighter(options);
+        },
         async codeToHtml(code, options) {
-            const shiki = await _getHighlighter({
-                lang: options.lang,
-                theme: ('theme' in options ? [options.theme] : Object.values(options.themes)),
+            const shiki = await getSingletonHighlighter({
+                langs: [options.lang],
+                themes: ('theme' in options ? [options.theme] : Object.values(options.themes)),
             });
             return shiki.codeToHtml(code, options);
         },
         async codeToHast(code, options) {
-            const shiki = await _getHighlighter({
-                lang: options.lang,
-                theme: ('theme' in options ? [options.theme] : Object.values(options.themes)),
+            const shiki = await getSingletonHighlighter({
+                langs: [options.lang],
+                themes: ('theme' in options ? [options.theme] : Object.values(options.themes)),
             });
             return shiki.codeToHast(code, options);
         },
         async codeToTokens(code, options) {
-            const shiki = await _getHighlighter({
-                lang: options.lang,
-                theme: ('theme' in options ? [options.theme] : Object.values(options.themes)),
+            const shiki = await getSingletonHighlighter({
+                langs: [options.lang],
+                themes: ('theme' in options ? [options.theme] : Object.values(options.themes)),
             });
             return shiki.codeToTokens(code, options);
         },
         async codeToTokensBase(code, options) {
-            const shiki = await _getHighlighter(options);
+            const shiki = await getSingletonHighlighter({
+                langs: [options.lang],
+                themes: [options.theme],
+            });
             return shiki.codeToTokensBase(code, options);
         },
         async codeToTokensWithThemes(code, options) {
-            const shiki = await _getHighlighter({
-                lang: options.lang,
-                theme: Object.values(options.themes).filter(Boolean),
+            const shiki = await getSingletonHighlighter({
+                langs: [options.lang],
+                themes: Object.values(options.themes).filter(Boolean),
             });
             return shiki.codeToTokensWithThemes(code, options);
         },
     };
 }
 
-export { FontStyle, ShikiError, addClassToHast, applyColorReplacements, codeToHast, codeToHtml, codeToTokens, codeToTokensBase, codeToTokensWithThemes, createPositionConverter, createSingletonShorthands, createdBundledHighlighter, getHighlighterCore, getShikiInternal, getTokenStyleObject, toHtml as hastToHtml, isNoneTheme, isPlainLang, isSpecialLang, isSpecialTheme, loadWasm, normalizeTheme, resolveColorReplacements, setDefaultWasmLoader, splitLines, splitToken, splitTokens, stringifyTokenStyle, toArray, tokenizeAnsiWithTheme, tokenizeWithTheme, tokensToHast, transformerDecorations };
+export { FontStyle, ShikiError, addClassToHast, applyColorReplacements, codeToHast, codeToHtml, codeToTokens, codeToTokensBase, codeToTokensWithThemes, createHighlighterCore, createPositionConverter, createShikiInternal, createSingletonShorthands, createdBundledHighlighter, getHighlighterCore, getShikiInternal, getSingletonHighlighterCore, getTokenStyleObject, toHtml as hastToHtml, isNoneTheme, isPlainLang, isSpecialLang, isSpecialTheme, loadWasm, makeSingletonHighlighter, makeSingletonHighlighterCore, normalizeTheme, resolveColorReplacements, setDefaultWasmLoader, splitLines, splitToken, splitTokens, stringifyTokenStyle, toArray, tokenizeAnsiWithTheme, tokenizeWithTheme, tokensToHast, transformerDecorations };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@shikijs/core",
   "type": "module",
-  "version": "1.8.0",
+  "version": "1.9.1",
   "description": "Core of Shiki",
   "author": "Pine Wu <octref@gmail.com>; Anthony Fu <anthonyfu117@hotmail.com>",
   "license": "MIT",