Create a universal ESM bundle for highlight.js #7790

Author: tobiu

buildScripts/buildHighlightJs.mjs

@@ -0,0 +1,75 @@
+import {execSync}      from 'child_process';
+import {fileURLToPath} from 'url';
+import fs              from 'fs-extra';
+import os              from 'os';
+import path            from 'path';
+import * as terser     from 'terser';
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const neoPath   = path.resolve(__dirname, '../');
+
+const languages     = ['bash', 'css', 'javascript', 'json', 'scss', 'xml'];
+const outputDir     = path.resolve(neoPath, 'dist/highlight');
+const outputFile    = path.join(outputDir,  'highlight.custom.js');
+const minOutputFile = path.join(outputDir,  'highlight.custom.min.js');
+const tempDir       = path.resolve(neoPath, 'tmp/highlightjs');
+
+const gitCmd  = os.platform().startsWith('win') ? 'git.exe' : 'git';
+const nodeCmd = os.platform().startsWith('win') ? 'node.exe' : 'node';
+const npmCmd  = os.platform().startsWith('win') ? 'npm.cmd' : 'npm';
+
+async function main() {
+    console.log('Building custom highlight.js bundle...');
+
+    try {
+        // 1. Clean up the temporary directory
+        console.log(`Cleaning up ${tempDir}`);
+        fs.removeSync(tempDir);
+        fs.ensureDirSync(tempDir);
+
+        // 2. Clone the highlight.js repository
+        console.log(`Cloning highlight.js into ${tempDir}`);
+        const cloneCommand = `${gitCmd} clone --depth 1 https://github.com/highlightjs/highlight.js.git ${tempDir}`;
+        execSync(cloneCommand, { stdio: 'inherit' });
+
+        // 3. Install dependencies
+        console.log(`Installing dependencies in ${tempDir}`);
+        const installCommand = `${npmCmd} install`;
+        execSync(installCommand, { cwd: tempDir, stdio: 'inherit' });
+
+        // 4. Run the build script
+        console.log('Running build script...');
+        const buildCommand = [
+            nodeCmd,
+            'tools/build.js',
+            '-n',
+            ...languages
+        ].join(' ');
+
+        execSync(buildCommand, { cwd: tempDir, stdio: 'inherit' });
+
+        // 5. Copy and minify the generated bundle
+        const generatedFile = path.join(tempDir, 'build/highlight.js');
+        console.log(`Copying ${generatedFile} to ${outputFile}`);
+        const bundleContent = fs.readFileSync(generatedFile, 'utf-8');
+        fs.ensureDirSync(outputDir);
+        fs.writeFileSync(outputFile, bundleContent);
+
+        console.log(`Minifying ${outputFile}`);
+        const minifiedContent = await terser.minify(bundleContent);
+        fs.writeFileSync(minOutputFile, minifiedContent.code);
+
+
+        // 6. Clean up the temporary directory
+        console.log(`Cleaning up ${tempDir}`);
+        fs.removeSync(tempDir);
+
+        console.log(`Custom highlight.js bundle created at: ${outputFile}`);
+        console.log(`Minified highlight.js bundle created at: ${minOutputFile}`);
+    } catch (error) {
+        console.error(`Error building highlight.js bundle: ${error}`);
+        // In case of error, leave the temporary directory for inspection
+    }
+}
+
+main();

package.json

@@ -21,6 +21,7 @@
         "build-all"                    : "node ./buildScripts/buildAll.mjs -f -n",
         "build-all-questions"          : "node ./buildScripts/buildAll.mjs -f",
         "build-dist-esm"               : "node ./buildScripts/buildESModules.mjs",
+        "build-highlightjs"            : "node ./buildScripts/buildHighlightJs.mjs",
         "build-themes"                 : "node ./buildScripts/buildThemes.mjs -f",
         "build-threads"                : "node ./buildScripts/webpack/buildThreads.mjs -f",
         "bundle-parse5"                : "node ./buildScripts/bundleParse5.mjs",
@@ -31,6 +32,7 @@
         "create-class"                 : "node ./buildScripts/createClass.mjs",
         "create-component"             : "node ./buildScripts/createComponent.mjs",
         "generate-docs-json"           : "node ./buildScripts/docs/jsdocx.mjs",
+        "postinstall"                  : "node ./buildScripts/buildHighlightJs.mjs",
         "prepare-release"              : "node ./buildScripts/prepareRelease.mjs",
         "server-start"                 : "webpack serve -c ./buildScripts/webpack/webpack.server.config.mjs --open",
         "test"                         : "playwright test -c test/playwright/playwright.config.mjs",