@shikijs/core 1.12.1 → 1.13.0

package/dist/chunk-tokens.d.mts

@@ -837,7 +837,7 @@ interface CodeToTokensWithThemesOptions<Languages = string, Themes = string> {
 }
 interface ThemedTokenScopeExplanation {
     scopeName: string;
-    themeMatches: any[];
+    themeMatches?: IRawThemeSetting[];
 }
 interface ThemedTokenExplanation {
     content: string;
@@ -945,9 +945,12 @@ interface TokenizeWithThemeOptions {
     /**
      * Include explanation of why a token is given a color.
      *
+     * You can optionally pass `scopeName` to only include explanation for scopes,
+     * which is more performant than full explanation.
+     *
      * @default false
      */
-    includeExplanation?: boolean;
+    includeExplanation?: boolean | 'scopeName';
     /**
      * A map of color names to new color values.
      *

package/dist/index.mjs

@@ -635,26 +635,6 @@ function _tokenizeWithTheme(code, grammar, theme, colorMap, options) {
             : INITIAL;
     let actual = [];
     const final = [];
-    const themeSettingsSelectors = [];
-    if (options.includeExplanation) {
-        for (const setting of theme.settings) {
-            let selectors;
-            switch (typeof setting.scope) {
-                case 'string':
-                    selectors = setting.scope.split(/,/).map(scope => scope.trim());
-                    break;
-                case 'object':
-                    selectors = setting.scope;
-                    break;
-                default:
-                    continue;
-            }
-            themeSettingsSelectors.push({
-                settings: setting,
-                selectors: selectors.map(selector => selector.split(/ /)),
-            });
-        }
-    }
     for (let i = 0, len = lines.length; i < len; i++) {
         const [line, lineOffset] = lines[i];
         if (line === '') {
@@ -698,6 +678,26 @@ function _tokenizeWithTheme(code, grammar, theme, colorMap, options) {
                 fontStyle,
             };
             if (options.includeExplanation) {
+                const themeSettingsSelectors = [];
+                if (options.includeExplanation !== 'scopeName') {
+                    for (const setting of theme.settings) {
+                        let selectors;
+                        switch (typeof setting.scope) {
+                            case 'string':
+                                selectors = setting.scope.split(/,/).map(scope => scope.trim());
+                                break;
+                            case 'object':
+                                selectors = setting.scope;
+                                break;
+                            default:
+                                continue;
+                        }
+                        themeSettingsSelectors.push({
+                            settings: setting,
+                            selectors: selectors.map(selector => selector.split(/ /)),
+                        });
+                    }
+                }
                 token.explanation = [];
                 let offset = 0;
                 while (startIndex + offset < nextStartIndex) {
@@ -706,7 +706,9 @@ function _tokenizeWithTheme(code, grammar, theme, colorMap, options) {
                     offset += tokenWithScopesText.length;
                     token.explanation.push({
                         content: tokenWithScopesText,
-                        scopes: explainThemeScopes(themeSettingsSelectors, tokenWithScopes.scopes),
+                        scopes: options.includeExplanation === 'scopeName'
+                            ? explainThemeScopesNameOnly(tokenWithScopes.scopes)
+                            : explainThemeScopesFull(themeSettingsSelectors, tokenWithScopes.scopes),
                     });
                     tokensWithScopesIndex += 1;
                 }
@@ -722,14 +724,16 @@ function _tokenizeWithTheme(code, grammar, theme, colorMap, options) {
         stateStack,
     };
 }
-function explainThemeScopes(themeSelectors, scopes) {
+function explainThemeScopesNameOnly(scopes) {
+    return scopes.map(scope => ({ scopeName: scope }));
+}
+function explainThemeScopesFull(themeSelectors, scopes) {
     const result = [];
     for (let i = 0, len = scopes.length; i < len; i++) {
-        const parentScopes = scopes.slice(0, i);
         const scope = scopes[i];
         result[i] = {
             scopeName: scope,
-            themeMatches: explainThemeScope(themeSelectors, scope, parentScopes),
+            themeMatches: explainThemeScope(themeSelectors, scope, scopes.slice(0, i)),
         };
     }
     return result;

package/package.json

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