@salesforcedevs/dx-components 1.20.7 → 1.20.8-shiki

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/dx-components",
-    "version": "1.20.7",
+    "version": "1.20.8-shiki",
     "description": "DX Lightning web components",
     "license": "MIT",
     "engines": {
@@ -46,6 +46,5 @@
     "volta": {
         "node": "20.19.0",
         "yarn": "1.22.19"
-    },
-    "gitHead": "fffbef4d7b536a321824457c6a987e53830a78f1"
+    }
 }

package/src/modules/dx/codeBlock/codeBlock.ts

@@ -2,7 +2,7 @@ import { LightningElement, api } from "lwc";
 import { CodeBlockTheme, CodeBlockLanguage } from "typings/custom";
 import cx from "classnames";
 import { track as gtmTrack } from "dxUtils/analytics";
-import { highlightCode } from "dxUtils/shiki";
+import { highlightCode, escapeHtml } from "dxUtils/shiki";
 
 /*
     Custom language support is handled by the Shiki wrapper module
@@ -118,6 +118,27 @@ export default class CodeBlock extends LightningElement {
         this.initializeTheme();
     }
 
+    // Show plain text immediately, no waiting for highlighting
+    private renderPlainCode(
+        cleanCodeBlock: string,
+        templateEl: HTMLTemplateElement,
+        divEl: HTMLElement | null
+    ) {
+        if (divEl) {
+            // Theme-specific colors to match Shiki's output
+            const bgColor = this.theme === DARK ? "#212121" : "#FFFFFF";
+            const textColor = this.theme === DARK ? "#EEFFFF" : "#000000";
+
+            // eslint-disable-next-line
+            templateEl.innerHTML = `<pre class='shiki' style='background-color: ${bgColor}; color: ${textColor};'><code>${escapeHtml(
+                cleanCodeBlock
+            )}</code></pre>`;
+            // eslint-disable-next-line
+            divEl.innerHTML = "";
+            divEl.append(templateEl.content);
+        }
+    }
+
     async formatCodeBlock() {
         const divEl = this.template.querySelector("div.code-block-content");
         const templateEl = document.createElement("template");
@@ -162,6 +183,9 @@ export default class CodeBlock extends LightningElement {
             ? "html"
             : this.selectedLanguage.id || "text";
 
+        // Render plain code immediately
+        this.renderPlainCode(cleanCodeBlock, templateEl, divEl);
+
         try {
             // Use Shiki to highlight the code with current theme
             const highlightedHtml = await highlightCode(

package/src/modules/dxUtils/shiki/__mocks__/shiki.ts

@@ -1,110 +1,24 @@
-// Mock for shiki module
-export const createHighlighter = jest.fn().mockImplementation(() => {
-    return Promise.resolve({
-        codeToHtml: jest.fn().mockImplementation((code, options) => {
-            // Preserve the original code content and add variable elements if present
-            let htmlContent = code;
+// Mock for Shiki module used in tests
+// This mock provides fallback implementations when Shiki can't load in test environment
+
+// Export the real escapeHtml function for use in tests
+export function escapeHtml(text: string): string {
+    const div = document.createElement("div");
+    div.textContent = text;
+    return div.innerHTML;
+}
+
+// Mock highlightCode that returns plain text fallback
+// This simulates the behavior when Shiki fails to load
+export async function highlightCode(
+    code: string,
+    language: string,
+    theme: "light" | "dark" = "light"
+): Promise<string> {
+    // Return plain text fallback just like the real function does when it fails
+    const bgColor = theme === "dark" ? "#212121" : "#FFFFFF";
+    const textColor = theme === "dark" ? "#EEFFFF" : "#000000";
+    
+    return `<pre class="shiki ${theme}" style="background-color: ${bgColor}; color: ${textColor};"><code>${escapeHtml(code)}</code></pre>`;
+}
 
-            // Check for <var> elements in the code and preserve them
-            if (code.includes("<var>")) {
-                // Replace <var> elements with tokenized spans
-                htmlContent = code.replace(
-                    /<var>(.*?)<\/var>/g,
-                    (match, content) =>
-                        `<span class="token variable"><var>${content}</var></span>`
-                );
-            }
-
-            // Add test content for specific test cases
-            if (code.includes("Salesforce Functions")) {
-                htmlContent = "Connected to Salesforce Functions";
-            }
-
-            return `<pre class="shiki ${
-                options?.theme || "light"
-            }"><code>${htmlContent}</code></pre>`;
-        }),
-        getLoadedLanguages: jest
-            .fn()
-            .mockReturnValue([
-                "javascript",
-                "typescript",
-                "html",
-                "css",
-                "apex",
-                "text",
-                "handlebars"
-            ])
-    });
-});
-
-export type Highlighter = {
-    codeToHtml: (code: string, options: any) => string;
-    getLoadedLanguages: () => string[];
-};
-
-export type BundledLanguage = string;
-export type BundledTheme = string;
-
-export const codeToHast = jest.fn();
-export const codeToHtml = jest.fn();
-export const codeToTokens = jest.fn();
-export const codeToTokensBase = jest.fn();
-export const codeToTokensWithThemes = jest.fn();
-export const getLastGrammarState = jest.fn();
-export const getSingletonHighlighter = jest.fn();
-
-// Mock for shiki/core exports
-export const createHighlighterCore = jest.fn().mockImplementation(() => {
-    return Promise.resolve({
-        codeToHtml: jest.fn().mockImplementation((code, options) => {
-            // Preserve the original code content and add variable elements if present
-            let htmlContent = code;
-
-            // Check for <var> elements in the code and preserve them
-            if (code.includes("<var>")) {
-                // Replace <var> elements with tokenized spans
-                htmlContent = code.replace(
-                    /<var>(.*?)<\/var>/g,
-                    (match, content) =>
-                        `<span class="token variable"><var>${content}</var></span>`
-                );
-            }
-
-            // Add test content for specific test cases
-            if (code.includes("Salesforce Functions")) {
-                htmlContent = "Connected to Salesforce Functions";
-            }
-
-            return `<pre class="shiki ${
-                options?.theme || "light"
-            }"><code>${htmlContent}</code></pre>`;
-        }),
-        getLoadedLanguages: jest
-            .fn()
-            .mockReturnValue([
-                "javascript",
-                "typescript",
-                "html",
-                "css",
-                "apex",
-                "text",
-                "handlebars"
-            ]),
-        loadLanguage: jest.fn().mockResolvedValue(undefined)
-    });
-});
-
-export type HighlighterCore = {
-    codeToHtml: (code: string, options: any) => string;
-    getLoadedLanguages: () => string[];
-    loadLanguage: (lang: any) => Promise<void>;
-};
-
-// Mock for shiki/engine/oniguruma
-export const createOnigurumaEngine = jest.fn().mockImplementation(() => {
-    return Promise.resolve({});
-});
-
-// Mock for shiki/wasm - just return a promise that resolves to a buffer
-export default Promise.resolve(new ArrayBuffer(0));

package/src/modules/dxUtils/shiki/shiki.ts

@@ -1,13 +1,23 @@
-import * as shiki from "shiki";
-
-import type { BundledLanguage, BundledTheme } from "shiki";
-import { transformerColorizedBrackets } from "@shikijs/colorized-brackets";
+import type { BundledLanguage, BundledTheme, HighlighterCore } from "shiki";
 import { getCustomLanguageGrammars } from "dxUtils/shikiGrammars";
 
+let shikiModulePromise: Promise<typeof import("shiki")> | null = null;
+let bracketsModulePromise: Promise<
+    typeof import("@shikijs/colorized-brackets")
+> | null = null;
+
+async function getShiki() {
+    return (shikiModulePromise ??= import("shiki"));
+}
+
+async function getBrackets() {
+    return (bracketsModulePromise ??= import("@shikijs/colorized-brackets"));
+}
+
 interface ShikiSingleton {
-    highlighter: shiki.HighlighterCore | null;
+    highlighter: HighlighterCore | null;
     initialized: boolean;
-    initPromise: Promise<shiki.HighlighterCore> | null;
+    initPromise: Promise<HighlighterCore> | null;
 }
 
 const shikiInstance: ShikiSingleton = {
@@ -50,8 +60,8 @@ const LANGUAGE_MAP: Record<string, BundledLanguage> = {
     sh: "bash"
 };
 
-// Core languages that should be loaded immediately for best performance
-const CORE_LANGUAGES = [
+// Core languages loaded eagerly (keep minimal; load others on demand)
+const CORE_LANGUAGES: BundledLanguage[] = [
     "apex",
     "javascript",
     "html",
@@ -91,8 +101,8 @@ const OPTIONAL_LANGUAGES: Record<string, any> = {
     agentscript: getCustomLanguageGrammars().agentscript
 };
 
-// Initialize Shiki highlighter with fine-grained modules for better performance
-async function initializeShiki(): Promise<shiki.HighlighterCore> {
+// Initialize Shiki highlighter (lazy-load module and keep initial set minimal)
+async function initializeShiki(): Promise<HighlighterCore> {
     if (shikiInstance.highlighter) {
         return shikiInstance.highlighter;
     }
@@ -101,6 +111,7 @@ async function initializeShiki(): Promise<shiki.HighlighterCore> {
         return shikiInstance.initPromise;
     }
 
+    const shiki = await getShiki();
     shikiInstance.initPromise = shiki.createHighlighter({
         themes: ["light-plus", "material-theme-darker"],
         langs: CORE_LANGUAGES
@@ -119,7 +130,7 @@ async function initializeShiki(): Promise<shiki.HighlighterCore> {
 
 // Async function to load additional languages when needed
 async function loadLanguageIfNeeded(
-    highlighter: shiki.HighlighterCore,
+    highlighter: HighlighterCore,
     language: string
 ): Promise<void> {
     const loadedLanguages = highlighter.getLoadedLanguages();
@@ -167,6 +178,8 @@ export async function highlightCode(
             mappedLanguage = "text" as BundledLanguage;
         }
 
+        const { transformerColorizedBrackets } = await getBrackets();
+
         return highlighter.codeToHtml(code, {
             lang: mappedLanguage,
             theme: THEME_MAP[theme],
@@ -184,7 +197,7 @@ export async function highlightCode(
 }
 
 // Utility function to escape HTML
-function escapeHtml(text: string): string {
+export function escapeHtml(text: string): string {
     const div = document.createElement("div");
     div.textContent = text;
     // eslint-disable-next-line @lwc/lwc/no-inner-html

package/LICENSE

@@ -1,12 +0,0 @@
-Copyright (c) 2020, Salesforce.com, Inc.
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
-* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-
-* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-
-* Neither the name of Salesforce.com nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.