quickbundle 2.7.0 → 2.8.0

package/README.md

@@ -10,9 +10,9 @@
 
 Quickbundle allows you to bundle a library in a **quick**, **fast** and **easy** way:
 
-- Fast build and watch mode powered by Rollup[^1] and SWC[^2].
-- Compile mode to create standalone binaries for systems that do not have Node.js installed[^3].
 - Zero configuration: define the build artifacts in your `package.json`, and you're all set!
+- Fast build and watch mode powered by Rollup[^1] and SWC[^2].
+- Compile and cross compile standalone executables for systems that do not have Node.js installed[^3].
 - Support of `cjs` & `esm` module formats output.
 - Support of several loaders including JavaScript, TypeScript, JSX, JSON, and Images.
 - TypeScript's declaration file (`.d.ts`) bundling.
@@ -113,7 +113,7 @@ yarn add quickbundle
 	"name": "lib", // Package name
 	"source": "./src/index.ts", // Source code entry point. Make sure that it starts with `#!/usr/bin/env node` pragme to make the binary portable for consumers who would like to use it by installing the package instead of using the generated standalone executable.
 	"bin": {
-		"your-binary-name": "./dist/index.cjs", // Binary information to get the executable name from the key and, from the value, the bundled file to generate from the source code and inject into the executable. The generated executable will be located in the same folder as the bundled file and, dependending on the current operating system running the `compile` command, the executable will be named either `your-binary-name.exe` on Windows or `your-binary-name` on Linux and macOS.
+		"your-binary-name": "./dist/index.cjs", // Binary information to get the executable name from the key and, from the value, the bundled file to generate from the source code and inject into the executable. The generated executable will be located in the same folder as the bundled file and, by default, dependending on the current operating system running the `compile` command, the executable will be named either `your-binary-name.exe` on Windows or `your-binary-name` on Linux and macOS. For cross-compilation output, check the `Patterns` section.
 	},
 	// "bin": "./dist/index.cjs", // Or, if the binary name follows the package name, you can define a string-based `bin` value.
 	"scripts": {
@@ -171,6 +171,24 @@ quickbundle watch --source-maps
 
 Enabling source map generation is needed only if a build is [obfuscated (minified)](#optimize-the-build-output) for debugging-easing purposes. It generally pairs with the [`minification` flag](#optimize-the-build-output).
 
+### Cross compilation to other platforms
+
+By default, the `compile` command embeds the runtime at the origin of its execution which means it generates executables compatible only with machines running the same operating system, processor architecture, and Node.js version.
+
+However, Quickbundle provides the ability to target a different operating system, processor architecture, or Node.js version (also known as cross-compilation):
+
+```bash
+quickbundle compile --target node-v23.1.0-darwin-arm64 # Embeds Node v23 runtime built for macOS ARM64 target
+quickbundle compile --target node-v23.1.0-darwin-x64 # Embeds Node v23 runtime built for macOS X64 target
+quickbundle compile --target node-v23.1.0-linux-arm64 # Embeds Node v23 runtime built for Linux ARM64 target
+quickbundle compile --target node-v23.1.0-linux-x64 # Embeds Node v23 runtime built for Linux X64 target
+quickbundle compile --target node-v23.1.0-win-arm64 # Embeds Node v23 runtime built for Windows ARM64 target
+quickbundle compile --target node-v23.1.0-win-x64 # Embeds Node v23 runtime built for Windows X64 target
+```
+
+> [!note]
+> The target input must follow the `node-vx.y.z-(darwin|linux|win)-(arm64|x64|x86)` format (for an exhaustive view, check available filenames in [https://nodejs.org/download/release/vx.y.z](https://nodejs.org/download/release/latest/)).
+
 <br>
 
 ## 🤩 Used by
@@ -195,3 +213,5 @@ We're open to new contributions, you can find more details [here](./CONTRIBUTING
 ## 📖 License
 
 [MIT](./LICENSE "License MIT").
+
+<br>

package/dist/index.mjs

@@ -1,8 +1,12 @@
 import { helpers, termost } from 'termost';
-import { readFile as readFile$1, writeFile, rm } from 'node:fs/promises';
+import { finished } from 'node:stream/promises';
+import { Readable } from 'node:stream';
 import process from 'node:process';
+import { resolve, dirname, join, basename } from 'node:path';
+import { copyFile as copyFile$1, rm, writeFile as writeFile$1, rename, mkdir, readFile as readFile$1 } from 'node:fs/promises';
+import { createWriteStream } from 'node:fs';
+import decompress from 'decompress';
 import { watch as watch$1, rollup } from 'rollup';
-import { join, basename, dirname, resolve } from 'node:path';
 import { createRequire } from 'node:module';
 import { swc } from 'rollup-plugin-swc3';
 import externals from 'rollup-plugin-node-externals';
@@ -15,11 +19,74 @@ import os from 'node:os';
 import { gzipSize } from 'gzip-size';
 
 var name = "quickbundle";
-var version = "2.7.0";
+var version = "2.8.0";
 
-const CWD = process.cwd();
-
-const readFile = readFile$1;
+/**
+ * Resolve a relative path from the Quickbundle node modules directory.
+ * @param paths - Relative paths.
+ * @returns The resolved absolute path.
+ * @example
+ * resolveFromInternalDirectory("dist", "node");
+ */ const resolveFromInternalDirectory = (...paths)=>{
+    return resolve(import.meta.dirname, "../", ...paths);
+};
+/**
+ * Resolve a relative path from the current working project directory.
+ * @param paths - Relative paths.
+ * @returns The resolved absolute path.
+ * @example
+ * resolveFromExternalDirectory("package.json");
+ */ const resolveFromExternalDirectory = (...paths)=>{
+    return resolve(process.cwd(), ...paths);
+};
+const createRegExpMatcher = (regex)=>{
+    return (value)=>{
+        return regex.exec(value)?.groups;
+    };
+};
+const createDirectory = async (path)=>{
+    await mkdir(path, {
+        recursive: true
+    });
+};
+const copyFile = async (fromPath, toPath)=>{
+    await createDirectory(dirname(toPath));
+    await copyFile$1(fromPath, toPath);
+};
+const removePath = async (path)=>{
+    await rm(path, {
+        force: true,
+        recursive: true
+    });
+};
+const readFile = async (filePath)=>{
+    return readFile$1(filePath);
+};
+const writeFile = async (filePath, content)=>{
+    await createDirectory(dirname(filePath));
+    await writeFile$1(filePath, content, "utf8");
+};
+const download = async (url, filePath)=>{
+    await createDirectory(dirname(filePath));
+    const { body, ok, status, statusText } = await fetch(url);
+    if (!ok) {
+        throw new Error(`An error ocurred while downloading \`${url}\`. Received \`${status}\` status code with the following message \`${statusText}\`.`);
+    }
+    if (!body) {
+        throw new Error(`Empty body received while downloading \`${url}\`.`);
+    }
+    await finished(Readable.fromWeb(body).pipe(createWriteStream(filePath)));
+};
+const unzip = async (input, output)=>{
+    const { targetedArchivePath } = input;
+    const { directoryPath } = output;
+    await decompress(input.path, directoryPath, {
+        filter (file) {
+            return file.path === targetedArchivePath;
+        }
+    });
+    await rename(join(directoryPath, targetedArchivePath), join(directoryPath, output.filename));
+};
 const createCommand = (program, input)=>{
     return program.command(input).option({
         key: "minification",
@@ -88,7 +155,7 @@ const clearLog = (...input)=>{
 };
 
 const require = createRequire(import.meta.url);
-const PKG = require(join(CWD, "./package.json"));
+const PKG = require(resolveFromExternalDirectory("package.json"));
 const createConfiguration = (options = {
     minification: false,
     sourceMaps: false,
@@ -321,17 +388,21 @@ const build = async (input)=>{
     return output;
 };
 
+const TEMPORARY_PATH = resolveFromInternalDirectory("dist", "tmp");
+const TEMPORARY_DOWNLOAD_PATH = join(TEMPORARY_PATH, "zip");
+const TEMPORARY_RUNTIME_PATH = join(TEMPORARY_PATH, "runtime");
 const createCompileCommand = (program)=>{
     return program.command({
         name: "compile",
         description: "Compiles the source code into a self-contained executable"
-    }).task({
-        key: "osType",
-        label: "Get context",
-        handler () {
-            const type = os.type();
-            return type === "Windows_NT" ? "windows" : type === "Darwin" ? "macos" : "linux";
-        }
+    }).option({
+        key: "targetInput",
+        name: {
+            long: "target",
+            short: "t"
+        },
+        description: "Set a different cross-compilation target",
+        defaultValue: "local"
     }).task({
         key: "config",
         label: "Create configuration",
@@ -342,6 +413,32 @@ const createCompileCommand = (program)=>{
                 standalone: true
             });
         }
+    }).task({
+        key: "osType",
+        label ({ targetInput }) {
+            return `Get \`${targetInput}\` runtime`;
+        },
+        async handler ({ targetInput }) {
+            if (targetInput === "local") {
+                await copyFile(process.execPath, TEMPORARY_RUNTIME_PATH);
+                return getOsType(os.type());
+            }
+            const matchedRuntimeParts = matchRuntimeParts(targetInput);
+            if (!matchedRuntimeParts) {
+                throw new Error("Invalid `runtime` flag input. The accepted targets are the one listed in https://nodejs.org/download/release/ with the following format `node-vx.y.z-(darwin|linux|win)-(arm64|x64|x86)`.");
+            }
+            const osType = getOsType(matchedRuntimeParts.os);
+            const extension = osType === "windows" ? "zip" : "tar.gz";
+            await download(`https://nodejs.org/download/release/${matchedRuntimeParts.version}/${targetInput}.${extension}`, TEMPORARY_DOWNLOAD_PATH);
+            await unzip({
+                path: TEMPORARY_DOWNLOAD_PATH,
+                targetedArchivePath: osType === "windows" ? join(targetInput, "node.exe") : join(targetInput, "bin", "node")
+            }, {
+                directoryPath: dirname(TEMPORARY_RUNTIME_PATH),
+                filename: basename(TEMPORARY_RUNTIME_PATH)
+            });
+            return osType;
+        }
     }).task({
         label: "Build",
         async handler ({ config }) {
@@ -367,6 +464,22 @@ const createCompileCommand = (program)=>{
         }
     });
 };
+const getOsType = (input)=>{
+    switch(input){
+        case "Windows_NT":
+        case "win":
+            return "windows";
+        case "Darwin":
+        case "darwin":
+            return "macos";
+        case "Linux":
+        case "linux":
+            return "linux";
+        default:
+            throw new Error(`Unsupported operating system \`${input}\``);
+    }
+};
+const matchRuntimeParts = createRegExpMatcher(/^node-(?<version>v\d+\.\d+\.\d+)-(?<os>darwin|linux|win)-(?<architecture>arm64|x64|x86)$/);
 const compile = async ({ bin, input, osType })=>{
     const inputFileName = basename(input);
     const inputDirectory = dirname(input);
@@ -382,11 +495,11 @@ const compile = async ({ bin, input, osType })=>{
         output: blobFileName,
         useCodeCache: false,
         useSnapshot: false
-    }), "utf-8");
+    }));
     await Promise.all([
-        `node --experimental-sea-config ${seaConfigFileName}`,
-        `node -e "require('fs').copyFileSync(process.execPath, '${executableFileName}')"`
-    ].map(async (command)=>helpers.exec(command)));
+        helpers.exec(`node --experimental-sea-config ${seaConfigFileName}`),
+        copyFile(TEMPORARY_RUNTIME_PATH, executableFileName)
+    ]);
     if (osType === "macos") {
         await helpers.exec(`codesign --remove-signature ${executableFileName}`);
     }
@@ -396,8 +509,9 @@ const compile = async ({ bin, input, osType })=>{
     }
     await Promise.all([
         blobFileName,
-        seaConfigFileName
-    ].map(async (file)=>rm(file)));
+        seaConfigFileName,
+        TEMPORARY_PATH
+    ].map(async (path)=>removePath(path)));
 };
 
 const createBuildCommand = (program)=>{

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "quickbundle",
-  "version": "2.7.0",
+  "version": "2.8.0",
   "description": "The zero-configuration transpiler and bundler for the web",
   "author": {
     "name": "Ayoub Adib",
@@ -53,6 +53,7 @@
     "@rollup/plugin-node-resolve": "^15.3.0",
     "@rollup/plugin-url": "^8.0.2",
     "@swc/core": "^1.9.1",
+    "decompress": "^4.2.1",
     "gzip-size": "^7.0.0",
     "rollup": "^4.24.4",
     "rollup-plugin-dts": "^6.1.1",
@@ -61,6 +62,7 @@
     "termost": "^1.2.0"
   },
   "devDependencies": {
+    "@types/decompress": "4.2.7",
     "@types/node": "22.9.0"
   },
   "scripts": {