@shikijs/core 1.18.0 → 1.19.0

package/dist/index.d.mts

@@ -1,10 +1,10 @@
-import { CreatedBundledHighlighterOptions, CreateHighlighterFactory, LanguageInput, ThemeInput, HighlighterCoreOptions, CodeToHastOptions, CodeToTokensOptions, TokensResult, RequireKeys, CodeToTokensBaseOptions, ThemedToken, CodeToTokensWithThemesOptions, ThemedTokenWithVariants, BundledHighlighterOptions, HighlighterGeneric, GrammarState, HighlighterCore, ShikiInternal, LoadWasmOptions, ShikiTransformerContextCommon, CodeToHastRenderOptions, ShikiTransformerContextSource, ThemeRegistrationResolved, TokenizeWithThemeOptions, ThemeRegistrationAny, ShikiTransformer, MaybeArray, PlainTextLanguage, SpecialLanguage, SpecialTheme, MaybeGetter, TokenStyles, Position } from '@shikijs/types';
+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, ThemeRegistrationAny, ShikiTransformer, MaybeArray, PlainTextLanguage, SpecialLanguage, SpecialTheme, MaybeGetter, TokenStyles, Position } from '@shikijs/types';
 export * from '@shikijs/types';
 import { Root, Element } from 'hast';
-export { createJavaScriptRegexEngine, defaultJavaScriptRegexConstructor } from '@shikijs/engine-javascript';
+import { JavaScriptRegexEngineOptions } from '@shikijs/engine-javascript';
+export { defaultJavaScriptRegexConstructor } from '@shikijs/engine-javascript';
 import { IGrammar } from '@shikijs/vscode-textmate';
 export { FontStyle, EncodedTokenMetadata as StackElementMetadata } from '@shikijs/vscode-textmate';
-export { createWasmOnigEngine, loadWasm } from '@shikijs/engine-oniguruma';
 export { toHtml as hastToHtml } from 'hast-util-to-html';
 
 /**
@@ -122,11 +122,10 @@ declare function getShikiInternal(options?: HighlighterCoreOptions): Promise<Shi
  */
 declare function createShikiInternalSync(options: HighlighterCoreOptions<true>): ShikiInternal;
 
-/**
- * Set the default wasm loader for `loadWasm`.
- * @internal
- */
-declare function setDefaultWasmLoader(_loader: LoadWasmOptions): void;
+declare function createJavaScriptRegexEngine(options?: JavaScriptRegexEngineOptions): RegexEngine;
+
+declare function createWasmOnigEngine(options?: LoadWasmOptions | null): Promise<RegexEngine>;
+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): Root;
@@ -219,7 +218,7 @@ declare function resolveColorReplacements(theme: ThemeRegistrationAny | string,
 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: Record<string, string>): string;
+declare function stringifyTokenStyle(token: string | Record<string, string>): string;
 /**
  * Creates a converter between index and position in a code block.
  *
@@ -231,4 +230,17 @@ declare function createPositionConverter(code: string): {
     posToIndex: (line: number, character: number) => number;
 };
 
-export { type ShorthandsBundle, addClassToHast, applyColorReplacements, codeToHast, codeToHtml, codeToTokens, codeToTokensBase, codeToTokensWithThemes, createHighlighterCore, createHighlighterCoreSync, createPositionConverter, createShikiInternal, createShikiInternalSync, createSingletonShorthands, createdBundledHighlighter, getHighlighterCore, getShikiInternal, getSingletonHighlighterCore, getTokenStyleObject, isNoneTheme, isPlainLang, isSpecialLang, isSpecialTheme, makeSingletonHighlighter, makeSingletonHighlighterCore, normalizeGetter, normalizeTheme, resolveColorReplacements, setDefaultWasmLoader, splitLines, splitToken, splitTokens, stringifyTokenStyle, toArray, tokenizeAnsiWithTheme, tokenizeWithTheme, tokensToHast, transformerDecorations };
+/**
+ * Enable runtime warning for deprecated APIs, for the future versions of Shiki.
+ *
+ * Disabled by default, will be enabled in Shiki v2.
+ *
+ * @experimental The accuracy of the warning messages is not yet guaranteed.
+ */
+declare function enableDeprecationWarnings(value?: boolean): void;
+/**
+ * @internal
+ */
+declare function warnDeprecated(message: string): void;
+
+export { type ShorthandsBundle, addClassToHast, applyColorReplacements, codeToHast, codeToHtml, codeToTokens, codeToTokensBase, codeToTokensWithThemes, createHighlighterCore, createHighlighterCoreSync, createJavaScriptRegexEngine, createPositionConverter, createShikiInternal, createShikiInternalSync, createSingletonShorthands, createWasmOnigEngine, createdBundledHighlighter, 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 };

package/dist/index.d.ts

@@ -1,10 +1,10 @@
-import { CreatedBundledHighlighterOptions, CreateHighlighterFactory, LanguageInput, ThemeInput, HighlighterCoreOptions, CodeToHastOptions, CodeToTokensOptions, TokensResult, RequireKeys, CodeToTokensBaseOptions, ThemedToken, CodeToTokensWithThemesOptions, ThemedTokenWithVariants, BundledHighlighterOptions, HighlighterGeneric, GrammarState, HighlighterCore, ShikiInternal, LoadWasmOptions, ShikiTransformerContextCommon, CodeToHastRenderOptions, ShikiTransformerContextSource, ThemeRegistrationResolved, TokenizeWithThemeOptions, ThemeRegistrationAny, ShikiTransformer, MaybeArray, PlainTextLanguage, SpecialLanguage, SpecialTheme, MaybeGetter, TokenStyles, Position } from '@shikijs/types';
+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, ThemeRegistrationAny, ShikiTransformer, MaybeArray, PlainTextLanguage, SpecialLanguage, SpecialTheme, MaybeGetter, TokenStyles, Position } from '@shikijs/types';
 export * from '@shikijs/types';
 import { Root, Element } from 'hast';
-export { createJavaScriptRegexEngine, defaultJavaScriptRegexConstructor } from '@shikijs/engine-javascript';
+import { JavaScriptRegexEngineOptions } from '@shikijs/engine-javascript';
+export { defaultJavaScriptRegexConstructor } from '@shikijs/engine-javascript';
 import { IGrammar } from '@shikijs/vscode-textmate';
 export { FontStyle, EncodedTokenMetadata as StackElementMetadata } from '@shikijs/vscode-textmate';
-export { createWasmOnigEngine, loadWasm } from '@shikijs/engine-oniguruma';
 export { toHtml as hastToHtml } from 'hast-util-to-html';
 
 /**
@@ -122,11 +122,10 @@ declare function getShikiInternal(options?: HighlighterCoreOptions): Promise<Shi
  */
 declare function createShikiInternalSync(options: HighlighterCoreOptions<true>): ShikiInternal;
 
-/**
- * Set the default wasm loader for `loadWasm`.
- * @internal
- */
-declare function setDefaultWasmLoader(_loader: LoadWasmOptions): void;
+declare function createJavaScriptRegexEngine(options?: JavaScriptRegexEngineOptions): RegexEngine;
+
+declare function createWasmOnigEngine(options?: LoadWasmOptions | null): Promise<RegexEngine>;
+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): Root;
@@ -219,7 +218,7 @@ declare function resolveColorReplacements(theme: ThemeRegistrationAny | string,
 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: Record<string, string>): string;
+declare function stringifyTokenStyle(token: string | Record<string, string>): string;
 /**
  * Creates a converter between index and position in a code block.
  *
@@ -231,4 +230,17 @@ declare function createPositionConverter(code: string): {
     posToIndex: (line: number, character: number) => number;
 };
 
-export { type ShorthandsBundle, addClassToHast, applyColorReplacements, codeToHast, codeToHtml, codeToTokens, codeToTokensBase, codeToTokensWithThemes, createHighlighterCore, createHighlighterCoreSync, createPositionConverter, createShikiInternal, createShikiInternalSync, createSingletonShorthands, createdBundledHighlighter, getHighlighterCore, getShikiInternal, getSingletonHighlighterCore, getTokenStyleObject, isNoneTheme, isPlainLang, isSpecialLang, isSpecialTheme, makeSingletonHighlighter, makeSingletonHighlighterCore, normalizeGetter, normalizeTheme, resolveColorReplacements, setDefaultWasmLoader, splitLines, splitToken, splitTokens, stringifyTokenStyle, toArray, tokenizeAnsiWithTheme, tokenizeWithTheme, tokensToHast, transformerDecorations };
+/**
+ * Enable runtime warning for deprecated APIs, for the future versions of Shiki.
+ *
+ * Disabled by default, will be enabled in Shiki v2.
+ *
+ * @experimental The accuracy of the warning messages is not yet guaranteed.
+ */
+declare function enableDeprecationWarnings(value?: boolean): void;
+/**
+ * @internal
+ */
+declare function warnDeprecated(message: string): void;
+
+export { type ShorthandsBundle, addClassToHast, applyColorReplacements, codeToHast, codeToHtml, codeToTokens, codeToTokensBase, codeToTokensWithThemes, createHighlighterCore, createHighlighterCoreSync, createJavaScriptRegexEngine, createPositionConverter, createShikiInternal, createShikiInternalSync, createSingletonShorthands, createWasmOnigEngine, createdBundledHighlighter, 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 };

package/dist/index.mjs

@@ -1,19 +1,22 @@
 import { ShikiError as ShikiError$1 } from '@shikijs/types';
 export * from '@shikijs/types';
+import { createWasmOnigEngine as createWasmOnigEngine$1, loadWasm as loadWasm$1, getDefaultWasmLoader } from '@shikijs/engine-oniguruma';
+import { w as warnDeprecated } from './shared/core.afb6276c.mjs';
+export { e as enableDeprecationWarnings } from './shared/core.afb6276c.mjs';
 import { FontStyle, INITIAL, EncodedTokenMetadata, Registry as Registry$1, Theme } from '@shikijs/vscode-textmate';
 export { FontStyle, EncodedTokenMetadata as StackElementMetadata } from '@shikijs/vscode-textmate';
 import { toHtml } from 'hast-util-to-html';
 export { toHtml as hastToHtml } from 'hast-util-to-html';
-import { createWasmOnigEngine } from '@shikijs/engine-oniguruma';
-export { createWasmOnigEngine, loadWasm } from '@shikijs/engine-oniguruma';
-export { createJavaScriptRegexEngine, defaultJavaScriptRegexConstructor } from '@shikijs/engine-javascript';
+import { createJavaScriptRegexEngine as createJavaScriptRegexEngine$1 } from '@shikijs/engine-javascript';
+export { defaultJavaScriptRegexConstructor } from '@shikijs/engine-javascript';
 
-let _defaultWasmLoader;
-function setDefaultWasmLoader(_loader) {
-  _defaultWasmLoader = _loader;
+function createWasmOnigEngine(options) {
+  warnDeprecated("import `createWasmOnigEngine` from `@shikijs/engine-oniguruma` or `shiki/engine/oniguruma` instead");
+  return createWasmOnigEngine$1(options);
 }
-function getDefaultWasmLoader() {
-  return _defaultWasmLoader;
+function loadWasm(options) {
+  warnDeprecated("import `loadWasm` from `@shikijs/engine-oniguruma` or `shiki/engine/oniguruma` instead");
+  return loadWasm$1(options);
 }
 
 function toArray(x) {
@@ -131,6 +134,8 @@ function getTokenStyleObject(token) {
   return styles;
 }
 function stringifyTokenStyle(token) {
+  if (typeof token === "string")
+    return token;
   return Object.entries(token).map(([key, value]) => `${key}:${value}`).join(";");
 }
 function createPositionConverter(code) {
@@ -1039,23 +1044,20 @@ function mergeToken(merged, variantsOrder, cssVariablePrefix, defaultColor) {
   };
   const styles = variantsOrder.map((t) => getTokenStyleObject(merged.variants[t]));
   const styleKeys = new Set(styles.flatMap((t) => Object.keys(t)));
-  const mergedStyles = styles.reduce((acc, cur, idx) => {
+  const mergedStyles = {};
+  styles.forEach((cur, idx) => {
     for (const key of styleKeys) {
       const value = cur[key] || "inherit";
       if (idx === 0 && defaultColor) {
-        acc[key] = value;
+        mergedStyles[key] = value;
       } else {
         const keyName = key === "color" ? "" : key === "background-color" ? "-bg" : `-${key}`;
         const varKey = cssVariablePrefix + variantsOrder[idx] + (key === "color" ? "" : keyName);
-        if (acc[key])
-          acc[key] += `;${varKey}:${value}`;
-        else
-          acc[key] = `${varKey}:${value}`;
+        mergedStyles[varKey] = value;
       }
     }
-    return acc;
-  }, {});
-  token.htmlStyle = defaultColor ? stringifyTokenStyle(mergedStyles) : Object.values(mergedStyles).join(";");
+  });
+  token.htmlStyle = mergedStyles;
   return token;
 }
 
@@ -1181,14 +1183,18 @@ function tokensToHast(tokens, options, transformerContext) {
       let tokenNode = {
         type: "element",
         tagName: "span",
-        properties: {},
+        properties: {
+          ...token.htmlAttrs
+        },
         children: [{ type: "text", value: token.content }]
       };
-      const style = token.htmlStyle || stringifyTokenStyle(getTokenStyleObject(token));
+      if (typeof token.htmlStyle === "string")
+        warnDeprecated("`htmlStyle` as a string is deprecated. Use an object instead.");
+      const style = stringifyTokenStyle(token.htmlStyle || getTokenStyleObject(token));
       if (style)
         tokenNode.properties.style = style;
       for (const transformer of transformers)
-        tokenNode = transformer?.span?.call(context, tokenNode, idx + 1, col, lineNode) || tokenNode;
+        tokenNode = transformer?.span?.call(context, tokenNode, idx + 1, col, lineNode, token) || tokenNode;
       if (structure === "inline")
         root.children.push(tokenNode);
       else if (structure === "classic")
@@ -1694,6 +1700,9 @@ function createShikiInternalSync(options) {
 }
 
 async function createShikiInternal(options = {}) {
+  if (options.loadWasm) {
+    warnDeprecated("`loadWasm` option is deprecated. Use `engine: createWasmOnigEngine(loadWasm)` instead.");
+  }
   const [
     themes,
     langs,
@@ -1701,7 +1710,7 @@ async function createShikiInternal(options = {}) {
   ] = await Promise.all([
     resolveThemes(options.themes || []),
     resolveLangs(options.langs || []),
-    options.engine || createWasmOnigEngine(options.loadWasm || getDefaultWasmLoader())
+    options.engine || createWasmOnigEngine$1(options.loadWasm || getDefaultWasmLoader())
   ]);
   return createShikiInternalSync({
     ...options,
@@ -1712,6 +1721,7 @@ async function createShikiInternal(options = {}) {
   });
 }
 function getShikiInternal(options = {}) {
+  warnDeprecated("`getShikiInternal` is deprecated. Use `createShikiInternal` instead.");
   return createShikiInternal(options);
 }
 
@@ -1764,6 +1774,7 @@ function makeSingletonHighlighterCore(createHighlighter) {
 }
 const getSingletonHighlighterCore = /* @__PURE__ */ makeSingletonHighlighterCore(createHighlighterCore);
 function getHighlighterCore(options = {}) {
+  warnDeprecated("`getHighlighterCore` is deprecated. Use `createHighlighterCore` or `getSingletonHighlighterCore` instead.");
   return createHighlighterCore(options);
 }
 
@@ -1772,6 +1783,7 @@ function createdBundledHighlighter(arg1, arg2, arg3) {
   let bundledThemes;
   let engine;
   if (arg2) {
+    warnDeprecated("`createdBundledHighlighter` signature with `bundledLanguages` and `bundledThemes` is deprecated. Use the options object signature instead.");
     bundledLanguages = arg1;
     bundledThemes = arg2;
     engine = () => createWasmOnigEngine(arg3);
@@ -1896,4 +1908,9 @@ function createSingletonShorthands(createHighlighter) {
   };
 }
 
-export { addClassToHast, applyColorReplacements, codeToHast, codeToHtml, codeToTokens, codeToTokensBase, codeToTokensWithThemes, createHighlighterCore, createHighlighterCoreSync, createPositionConverter, createShikiInternal, createShikiInternalSync, createSingletonShorthands, createdBundledHighlighter, getHighlighterCore, getShikiInternal, getSingletonHighlighterCore, getTokenStyleObject, isNoneTheme, isPlainLang, isSpecialLang, isSpecialTheme, makeSingletonHighlighter, makeSingletonHighlighterCore, normalizeGetter, normalizeTheme, resolveColorReplacements, setDefaultWasmLoader, splitLines, splitToken, splitTokens, stringifyTokenStyle, toArray, tokenizeAnsiWithTheme, tokenizeWithTheme, tokensToHast, transformerDecorations };
+function createJavaScriptRegexEngine(options) {
+  warnDeprecated("import `createJavaScriptRegexEngine` from `@shikijs/engine-javascript` or `shiki/engine/javascript` instead");
+  return createJavaScriptRegexEngine$1(options);
+}
+
+export { addClassToHast, applyColorReplacements, codeToHast, codeToHtml, codeToTokens, codeToTokensBase, codeToTokensWithThemes, createHighlighterCore, createHighlighterCoreSync, createJavaScriptRegexEngine, createPositionConverter, createShikiInternal, createShikiInternalSync, createSingletonShorthands, createWasmOnigEngine, createdBundledHighlighter, getHighlighterCore, getShikiInternal, getSingletonHighlighterCore, getTokenStyleObject, isNoneTheme, isPlainLang, isSpecialLang, isSpecialTheme, loadWasm, makeSingletonHighlighter, makeSingletonHighlighterCore, normalizeGetter, normalizeTheme, resolveColorReplacements, splitLines, splitToken, splitTokens, stringifyTokenStyle, toArray, tokenizeAnsiWithTheme, tokenizeWithTheme, tokensToHast, transformerDecorations, warnDeprecated };

package/dist/shared/core.afb6276c.mjs

@@ -0,0 +1,10 @@
+let emitDeprecation = false;
+function enableDeprecationWarnings(value = true) {
+  emitDeprecation = value;
+}
+function warnDeprecated(message) {
+  if (emitDeprecation)
+    console.trace(`[SHIKI DEPRECATE]: ${message}`);
+}
+
+export { enableDeprecationWarnings as e, warnDeprecated as w };

package/dist/wasm-inlined.mjs

@@ -1,2 +1,5 @@
+import { w as warnDeprecated } from './shared/core.afb6276c.mjs';
 export * from '@shikijs/engine-oniguruma/wasm-inlined';
 export { default } from '@shikijs/engine-oniguruma/wasm-inlined';
+
+warnDeprecated("Import from `@shikijs/engine-oniguruma/wasm-inlined` instead");

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@shikijs/core",
   "type": "module",
-  "version": "1.18.0",
+  "version": "1.19.0",
   "description": "Core of Shiki",
   "author": "Pine Wu <octref@gmail.com>; Anthony Fu <anthonyfu117@hotmail.com>",
   "license": "MIT",
@@ -63,9 +63,9 @@
     "@shikijs/vscode-textmate": "^9.2.2",
     "@types/hast": "^3.0.4",
     "hast-util-to-html": "^9.0.3",
-    "@shikijs/engine-oniguruma": "1.18.0",
-    "@shikijs/types": "1.18.0",
-    "@shikijs/engine-javascript": "1.18.0"
+    "@shikijs/engine-javascript": "1.19.0",
+    "@shikijs/engine-oniguruma": "1.19.0",
+    "@shikijs/types": "1.19.0"
   },
   "scripts": {
     "build": "unbuild",