Merge 65838a39274e27b4a431dae3eb9fe277fa2fc857 into 37a92460f0b1d32c8e78ce92f4b1ed860e3e0b5c

Gruntfile.js

@@ -5,6 +5,7 @@ const HtmlWebpackPlugin = require("html-webpack-plugin");
 const BundleAnalyzerPlugin = require("webpack-bundle-analyzer").BundleAnalyzerPlugin;
 const glob = require("glob");
 const path = require("path");
+const os = require("os");
 
 const nodeFlags = "--no-warnings --no-deprecation";
 
@@ -23,25 +24,25 @@ module.exports = function (grunt) {
     // Tasks
     grunt.registerTask("dev",
         "A persistent task which creates a development build whenever source files are modified.",
-        ["clean:dev", "clean:config", "exec:generateConfig", "concurrent:dev"]);
+        ["clean:dev", "clean:config", "generateConfig", "concurrent:dev"]);
 
     grunt.registerTask("prod",
         "Creates a production-ready build. Use the --msg flag to add a compile message.",
         [
-            "eslint", "clean:prod", "clean:config", "exec:generateConfig", "findModules", "webpack:web",
+            "eslint", "clean:prod", "clean:config", "generateConfig", "findModules", "webpack:web",
-            "copy:standalone", "zip:standalone", "clean:standalone", "exec:calcDownloadHash", "chmod"
+            "copy:standalone", "zip:standalone", "clean:standalone", "calcDownloadHash", "chmod"
         ]);
 
     grunt.registerTask("node",
         "Compiles CyberChef into a single NodeJS module.",
         [
-            "clean:node", "clean:config", "clean:nodeConfig", "exec:generateConfig", "exec:generateNodeIndex"
+            "clean:node", "clean:config", "clean:nodeConfig", "generateConfig", "generateNodeIndex"
         ]);
 
     grunt.registerTask("configTests",
         "A task which configures config files in preparation for tests to be run. Use `npm test` to run tests.",
         [
-            "clean:config", "clean:nodeConfig", "exec:generateConfig", "exec:generateNodeIndex"
+            "clean:config", "clean:nodeConfig", "generateConfig", "generateNodeIndex"
         ]);
 
     grunt.registerTask("testui",
@@ -50,11 +51,11 @@ module.exports = function (grunt) {
 
     grunt.registerTask("testnodeconsumer",
         "A task which checks whether consuming CJS and ESM apps work with the CyberChef build",
-        ["exec:setupNodeConsumers", "exec:testCJSNodeConsumer", "exec:testESMNodeConsumer", "exec:teardownNodeConsumers"]);
+        ["setupNodeConsumers", "exec:testCJSNodeConsumer", "exec:testESMNodeConsumer", "teardownNodeConsumers"]);
 
     grunt.registerTask("default",
         "Lints the code base",
-        ["eslint", "exec:repoSize"]);
+        ["eslint", "repoSize"]);
 
     grunt.registerTask("lint", "eslint");
 
@@ -97,7 +98,7 @@ module.exports = function (grunt) {
             PKG_VERSION: JSON.stringify(pkg.version),
         },
         moduleEntryPoints = listEntryModules(),
-        nodeConsumerTestPath = "~/tmp-cyberchef",
+        nodeConsumerTestPath = path.join(os.tmpdir(), "tmp-cyberchef"),
         /**
          * Configuration for Webpack production build. Defined as a function so that it
          * can be recalculated when new modules are generated.
@@ -110,7 +111,7 @@ module.exports = function (grunt) {
                     main: "./src/web/index.js"
                 }, moduleEntryPoints),
                 output: {
-                    path: __dirname + "/build/prod",
+                    path: path.join(__dirname, "build", "prod"),
                     filename: chunkData => {
                         return chunkData.chunk.name === "main" ? "assets/[name].js": "[name].js";
                     },
@@ -162,25 +163,68 @@ module.exports = function (grunt) {
         return entryModules;
     }
 
-    /**
+    grunt.registerTask("calcDownloadHash", "Computes the SHA256 of the standalone zip and stamps it into index.html", function () {
-     * Detects the correct delimiter to use to chain shell commands together
+        const crypto = require("crypto");
-     * based on the current OS.
+        const fs = require("fs");
-     *
+        const zipPath = path.join("build", "prod", `CyberChef_v${pkg.version}.zip`);
-     * @param {string[]} cmds
+        const digestPath = path.join("build", "prod", "sha256digest.txt");
-     * @returns {string}
+        const indexPath = path.join("build", "prod", "index.html");
-     */
+        const hash = crypto.createHash("sha256").update(fs.readFileSync(zipPath)).digest("hex");
-    function chainCommands(cmds) {
+        fs.writeFileSync(digestPath, hash);
-        const win = process.platform === "win32";
+        const html = fs.readFileSync(indexPath, "utf8").replace("DOWNLOAD_HASH_PLACEHOLDER", hash);
-        if (!win) {
+        fs.writeFileSync(indexPath, html);
-            return cmds.join(";");
+    });
-        }
+
-        return cmds
+    grunt.registerTask("repoSize", "Reports tracked file count and repo size", function () {
-            // && means that subsequent commands will not be executed if the
+        const { execSync } = require("child_process");
-            // previous one fails. & would coninue on a fail
+        const fs = require("fs");
-            .join("&&")
+        const fileCount = execSync("git ls-files", { encoding: "utf8" }).trim().split("\n").length;
-            // Windows does not support \n properly
+        let bytes = 0;
-            .replace(/\n/g, "\\n");
+        const walk = (dir) => {
-    }
+            for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
+                if (entry.name === ".git" || entry.name === "node_modules") continue;
+                const p = path.join(dir, entry.name);
+                if (entry.isDirectory()) walk(p);
+                else if (entry.isFile()) bytes += fs.statSync(p).size;
+            }
+        };
+        walk(".");
+        const mb = (bytes / (1024 * 1024)).toFixed(1);
+        grunt.log.writeln(`\n${fileCount}\ttracked files`);
+        grunt.log.writeln(`${mb}M\trepository size`);
+    });
+
+    grunt.registerTask("generateConfig", "Regenerates operation config files", function () {
+        const { execSync } = require("child_process");
+        const fs = require("fs");
+        grunt.log.writeln("\n--- Regenerating config files. ---");
+        fs.writeFileSync(path.join("src", "core", "config", "OperationConfig.json"), "[]\n");
+        execSync(`node ${nodeFlags} src/core/config/scripts/generateOpsIndex.mjs`, { stdio: "inherit" });
+        execSync(`node ${nodeFlags} src/core/config/scripts/generateConfig.mjs`, { stdio: "inherit" });
+        grunt.log.writeln("--- Config scripts finished. ---\n");
+    });
+
+    grunt.registerTask("generateNodeIndex", "Regenerates the node index", function () {
+        const { execSync } = require("child_process");
+        grunt.log.writeln("\n--- Regenerating node index ---");
+        execSync(`node ${nodeFlags} src/node/config/scripts/generateNodeIndex.mjs`, { stdio: "inherit" });
+        grunt.log.writeln("--- Node index generated. ---\n");
+    });
+
+    grunt.registerTask("setupNodeConsumers", "Sets up a temp dir for testing CJS/ESM consumers", function () {
+        const fs = require("fs");
+        const { execSync } = require("child_process");
+        grunt.log.writeln("\n--- Testing node consumers ---");
+        fs.mkdirSync(nodeConsumerTestPath, { recursive: true });
+        fs.cpSync("tests/node/consumers", nodeConsumerTestPath, { recursive: true });
+        execSync("npm link", { stdio: "inherit" });
+        execSync("npm link cyberchef", { stdio: "inherit", cwd: nodeConsumerTestPath });
+    });
+
+    grunt.registerTask("teardownNodeConsumers", "Removes the consumer test temp dir", function () {
+        require("fs").rmSync(nodeConsumerTestPath, { recursive: true, force: true });
+        grunt.log.writeln("\n--- Node consumer tests complete ---");
+    });
 
     grunt.initConfig({
         clean: {
@@ -318,7 +362,7 @@ module.exports = function (grunt) {
         watch: {
             config: {
                 files: ["src/core/operations/**/*", "!src/core/operations/index.mjs"],
-                tasks: ["exec:generateNodeIndex", "exec:generateConfig"]
+                tasks: ["generateNodeIndex", "generateConfig"]
             }
         },
         concurrent: {
@@ -328,29 +372,6 @@ module.exports = function (grunt) {
             }
         },
         exec: {
-            calcDownloadHash: {
-                command: function () {
-                    switch (process.platform) {
-                        case "darwin":
-                            return chainCommands([
-                                `shasum -a 256 build/prod/CyberChef_v${pkg.version}.zip | awk '{print $1;}' > build/prod/sha256digest.txt`,
-                                `sed -i '' -e "s/DOWNLOAD_HASH_PLACEHOLDER/$(cat build/prod/sha256digest.txt)/" build/prod/index.html`
-                            ]);
-                        default:
-                            return chainCommands([
-                                `sha256sum build/prod/CyberChef_v${pkg.version}.zip | awk '{print $1;}' > build/prod/sha256digest.txt`,
-                                `sed -i -e "s/DOWNLOAD_HASH_PLACEHOLDER/$(cat build/prod/sha256digest.txt)/" build/prod/index.html`
-                            ]);
-                    }
-                },
-            },
-            repoSize: {
-                command: chainCommands([
-                    "git ls-files | wc -l | xargs printf '\n%b\ttracked files\n'",
-                    "du -hs | egrep -o '^[^\t]*' | xargs printf '%b\trepository size\n'"
-                ]),
-                stderr: false
-            },
             cleanGit: {
                 command: "git gc --prune=now --aggressive"
             },
@@ -358,56 +379,17 @@ module.exports = function (grunt) {
                 command: `node ${nodeFlags} src/web/static/sitemap.mjs > build/prod/sitemap.xml`,
                 sync: true
             },
-            generateConfig: {
-                command: chainCommands([
-                    "echo '\n--- Regenerating config files. ---'",
-                    "echo [] > src/core/config/OperationConfig.json",
-                    `node ${nodeFlags} src/core/config/scripts/generateOpsIndex.mjs`,
-                    `node ${nodeFlags} src/core/config/scripts/generateConfig.mjs`,
-                    "echo '--- Config scripts finished. ---\n'"
-                ]),
-                sync: true
-            },
-            generateNodeIndex: {
-                command: chainCommands([
-                    "echo '\n--- Regenerating node index ---'",
-                    `node ${nodeFlags} src/node/config/scripts/generateNodeIndex.mjs`,
-                    "echo '--- Node index generated. ---\n'"
-                ]),
-                sync: true
-            },
             browserTests: {
                 command: "./node_modules/.bin/nightwatch --env prod"
             },
-            setupNodeConsumers: {
-                command: chainCommands([
-                    "echo '\n--- Testing node consumers ---'",
-                    "npm link",
-                    `mkdir ${nodeConsumerTestPath}`,
-                    `cp tests/node/consumers/* ${nodeConsumerTestPath}`,
-                    `cd ${nodeConsumerTestPath}`,
-                    "npm link cyberchef"
-                ]),
-                sync: true
-            },
-            teardownNodeConsumers: {
-                command: chainCommands([
-                    `rm -rf ${nodeConsumerTestPath}`,
-                    "echo '\n--- Node consumer tests complete ---'"
-                ]),
-            },
             testCJSNodeConsumer: {
-                command: chainCommands([
+                command: `node ${nodeFlags} cjs-consumer.js`,
-                    `cd ${nodeConsumerTestPath}`,
+                cwd: nodeConsumerTestPath,
-                    `node ${nodeFlags} cjs-consumer.js`,
-                ]),
                 stdout: false,
             },
             testESMNodeConsumer: {
-                command: chainCommands([
+                command: `node ${nodeFlags} esm-consumer.mjs`,
-                    `cd ${nodeConsumerTestPath}`,
+                cwd: nodeConsumerTestPath,
-                    `node ${nodeFlags} esm-consumer.mjs`,
-                ]),
                 stdout: false,
             },
             fixCryptoApiImports: {

package.json

@@ -205,10 +205,9 @@
     "lint:grammar": "cspell ./src",
     "postinstall": "npx grunt exec:fixCryptoApiImports && npx grunt exec:fixSnackbarMarkup",
     "newop": "node src/core/config/scripts/newOperation.mjs",
-    "minor": "node src/core/config/scripts/newMinorVersion.mjs && npm version minor --git-tag-version=false && echo \"Updated to version v$(npm pkg get version | xargs), please create a pull request and once merged use 'npm run tag'\"",
+    "minor": "node src/core/config/scripts/bumpMinor.mjs",
-    "tag": "git tag -s \"v$(npm pkg get version | xargs)\" -m \"$(npm pkg get version | xargs)\" && echo \"Created v$(npm pkg get version | xargs), now check and push the tag\"",
+    "tag": "node src/core/config/scripts/tagRelease.mjs",
-    "getheapsize": "node -e 'console.log(`node heap limit = ${require(\"v8\").getHeapStatistics().heap_size_limit / (1024 * 1024)} Mb`)'",
+    "getheapsize": "node --no-warnings src/core/config/scripts/getHeapSize.mjs"
-    "setheapsize": "export NODE_OPTIONS=--max_old_space_size=2048"
   },
   "engines": {
     "node": ">=24 <25"

src/core/config/scripts/bumpMinor.mjs

@@ -0,0 +1,27 @@
+/**
+ * Orchestrates a minor version bump: regenerates the CHANGELOG via
+ * newMinorVersion.mjs, runs `npm version minor` (without a git tag),
+ * then prints a follow-up message that includes the new version.
+ *
+ * Replaces the previous shell-substitution npm script so it works on
+ * Windows cmd.exe as well as POSIX shells.
+ *
+ * @author n1474335 [n1474335@gmail.com]
+ * @copyright Crown Copyright 2026
+ * @license Apache-2.0
+ */
+
+/* eslint no-console: ["off"] */
+
+import { execSync } from "child_process";
+import { readFileSync } from "fs";
+import { dirname, join } from "path";
+import { fileURLToPath } from "url";
+
+const pkgPath = join(dirname(fileURLToPath(import.meta.url)), "..", "..", "..", "..", "package.json");
+
+execSync("node src/core/config/scripts/newMinorVersion.mjs", { stdio: "inherit" });
+execSync("npm version minor --git-tag-version=false", { stdio: "inherit" });
+
+const version = JSON.parse(readFileSync(pkgPath, "utf8")).version;
+console.log(`Updated to version v${version}, please create a pull request and once merged use 'npm run tag'`);

src/core/config/scripts/getHeapSize.mjs

@@ -0,0 +1,13 @@
+/**
+ * Prints the Node V8 heap size limit in MB.
+ *
+ * @author n1474335 [n1474335@gmail.com]
+ * @copyright Crown Copyright 2026
+ * @license Apache-2.0
+ */
+
+/* eslint no-console: ["off"] */
+
+import v8 from "v8";
+
+console.log(`node heap limit = ${v8.getHeapStatistics().heap_size_limit / (1024 * 1024)} Mb`);

src/core/config/scripts/tagRelease.mjs

@@ -0,0 +1,24 @@
+/**
+ * Creates a signed git tag matching the version in package.json,
+ * then prints a follow-up message.
+ *
+ * Replaces the previous shell-substitution npm script so it works on
+ * Windows cmd.exe as well as POSIX shells.
+ *
+ * @author n1474335 [n1474335@gmail.com]
+ * @copyright Crown Copyright 2026
+ * @license Apache-2.0
+ */
+
+/* eslint no-console: ["off"] */
+
+import { execSync } from "child_process";
+import { readFileSync } from "fs";
+import { dirname, join } from "path";
+import { fileURLToPath } from "url";
+
+const pkgPath = join(dirname(fileURLToPath(import.meta.url)), "..", "..", "..", "..", "package.json");
+const version = JSON.parse(readFileSync(pkgPath, "utf8")).version;
+
+execSync(`git tag -s "v${version}" -m "${version}"`, { stdio: "inherit" });
+console.log(`Created v${version}, now check and push the tag`);

webpack.config.js

@@ -142,7 +142,7 @@ module.exports = {
         rules: [
             {
                 test: /\.m?js$/,
-                exclude: /node_modules\/(?!crypto-api|bootstrap)/,
+                exclude: /node_modules[/\\](?!crypto-api|bootstrap)/,
                 options: {
                     configFile: path.resolve(__dirname, "babel.config.js"),
                     cacheDirectory: true,
@@ -205,7 +205,7 @@ module.exports = {
                 type: "asset/inline",
             },
             { // Store font .fnt and .png files in a separate fonts folder
-                test: /(\.fnt$|bmfonts\/.+\.png$)/,
+                test: /(\.fnt$|bmfonts[/\\].+\.png$)/,
                 type: "asset/resource",
                 generator: {
                     filename: "assets/fonts/[name][ext]"
@@ -221,7 +221,7 @@ module.exports = {
             },
             { // Third party images are inlined
                 test: /\.(png|jpg|gif)$/,
-                exclude: /web\/static/,
+                exclude: /web[/\\]static/,
                 type: "asset/inline",
             },
         ]