nw-builder 4.3.5 → 4.3.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nw-builder",
-  "version": "4.3.5",
+  "version": "4.3.7",
   "description": "Build NW.js desktop applications for MacOS, Windows and Linux.",
   "keywords": [
     "NW.js",
@@ -40,8 +40,10 @@
     "url": "https://github.com/nwutils/nw-builder.git"
   },
   "scripts": {
+    "ci:fmt": "prettier --check \"./**/*.{css,html,js,json,md,yml}\"",
+    "ci:lnt": "eslint --config=cfg/eslint.config.cjs cfg src test",
     "fmt": "prettier --write \"./**/*.{css,html,js,json,md,yml}\"",
-    "lnt": "eslint --config=cfg/eslint.config.cjs --fix src test",
+    "lnt": "eslint --config=cfg/eslint.config.cjs --fix cfg src test",
     "doc:dev": "concurrently --kill-others \"node cfg/fswatch.config.js\" \"vitepress dev doc\"",
     "doc:bld": "vitepress build doc",
     "test:unit": "node --test-reporter=spec --test test/unit/index.js",

package/src/bld/winCfg.js

@@ -60,10 +60,10 @@ const setWinConfig = async (app, outDir) => {
     "file-version": app.version,
     "product-version": app.version,
     "version-string": versionString,
-  }
+  };
 
   if (app.icon) {
-    rcEditOptions.icon = app.icon
+    rcEditOptions.icon = app.icon;
   }
 
   try {

package/src/get.js

@@ -1,25 +1,15 @@
 import { createWriteStream } from "node:fs";
-
 import { mkdir, readdir, rm, rmdir } from "node:fs/promises";
 import { get as getRequest } from "node:https";
 import { resolve } from "node:path";
 import { arch as ARCH, platform as PLATFORM } from "node:process";
-import { log } from "./log.js";
 
 import progress from "cli-progress";
 import compressing from "compressing";
 
-const PLATFORM_KV = {
-  darwin: "osx",
-  linux: "linux",
-  win32: "win",
-};
-
-const ARCH_KV = {
-  x64: "x64",
-  ia32: "ia32",
-  arm64: "arm64",
-};
+import { log } from "./log.js";
+import { PLATFORM_KV, ARCH_KV } from "./util.js";
+import { replaceFfmpeg } from "./util/ffmpeg.js";
 
 /**
  * _Note: This an internal function which is not called directly. Please see example usage below._
@@ -55,7 +45,7 @@ const ARCH_KV = {
  *  mode: "get",
  *  downloadUrl: "https://cnpmjs.org/mirrors/nwjs/",
  * });
- * 
+ *
  * @example
  * // FFmpeg (proprietary codecs)
  * // Please read the license's constraints: https://nwjs.readthedocs.io/en/latest/For%20Developers/Enable%20Proprietary%20Codecs/#get-ffmpeg-binaries-from-the-community
@@ -133,7 +123,7 @@ export async function get({
   }
 
   // If not cached, then download.
-  if (nwCached === false) {
+  if (nwCached === false || ffmpeg === true) {
     log.debug(`Downloading binaries`);
     await mkdir(nwDir, { recursive: true });
 
@@ -144,7 +134,7 @@ export async function get({
         // For GitHub releases and mirrors, we need to follow the redirect.
         if (
           downloadUrl ===
-          "https://github.com/nwjs-ffmpeg-prebuilt/nwjs-ffmpeg-prebuilt/releases/download" ||
+            "https://github.com/nwjs-ffmpeg-prebuilt/nwjs-ffmpeg-prebuilt/releases/download" ||
           downloadUrl === "https://npm.taobao.org/mirrors/nwjs" ||
           downloadUrl === "https://npmmirror.com/mirrors/nwjs"
         ) {
@@ -190,6 +180,18 @@ export async function get({
 
     // Remove compressed file after download and decompress.
     return request.then(async () => {
+      if (ffmpeg === true) {
+        let ffmpegFile;
+        if (platform === "linux") {
+          ffmpegFile = "libffmpeg.so";
+        } else if (platform === "win") {
+          ffmpegFile = "ffmpeg.dll";
+        } else if (platform === "osx") {
+          ffmpegFile = "libffmpeg.dylib";
+        }
+        await replaceFfmpeg(platform, nwDir, ffmpegFile);
+      }
+
       log.debug(`Binary decompressed starting removal`);
       await rm(resolve(cacheDir, "ffmpeg.zip"), {
         recursive: true,

package/src/index.js

@@ -3,7 +3,7 @@ import { resolve } from "node:path";
 import { arch, platform, version } from "node:process";
 
 import { build } from "./bld/build.js";
-import { develop } from "./run/develop.js";
+import { run } from "./run.js";
 import { isCached } from "./util/cache.js";
 import { getFiles } from "./util/files.js";
 import { getVersionManifest } from "./util/versionManifest.js";
@@ -137,15 +137,17 @@ const nwbuild = async (options) => {
     }
 
     if (options.mode === "run") {
-      await develop(
-        options.srcDir,
-        nwDir,
-        options.platform,
-        options.argv,
-        options.glob,
-      );
-    }
-    else if (options.mode === "build") {
+      await run({
+        version: options.version,
+        flavor: options.flavor,
+        platform: options.platform,
+        arch: options.arch,
+        srcDir: options.srcDir,
+        cacheDir: options.cacheDir,
+        glob: options.glob,
+        argv: options.argv,
+      });
+    } else if (options.mode === "build") {
       await build(
         options.glob === true ? files : options.srcDir,
         nwDir,

package/src/run.js

@@ -0,0 +1,76 @@
+import { spawn } from "node:child_process";
+import { resolve } from "node:path";
+import { arch as ARCH, platform as PLATFORM } from "node:process";
+
+import { log } from "./log.js";
+import { EXE_NAME, ARCH_KV, PLATFORM_KV } from "./util.js";
+
+/**
+ * _Note: This an internal function which is not called directly. Please see example usage below._
+ *
+ * Run NW.js application. You can use get mode options in run mode too.
+ *
+ * @example
+ * // Minimal Usage (uses default values)
+ * nwbuild({
+ *   mode: "run",
+ * });
+ *
+ * @param  {options}                  options           Run mode options
+ * @param  {string}                   options.version   NW.js runtime version. Defaults to "latest".
+ * @param  {"normal" | "sdk"}         options.flavor    NW.js build flavor. Defaults to "normal".
+ * @param  {"linux" | "osx" | "win"}  options.platform  Target platform. Defaults to host platform.
+ * @param  {"ia32" | "x64" | "arm64"} options.arch      Target architecture. Defaults to host architecture.
+ * @param  {string}                   options.srcDir    Source directory path. Defaults to "./src"
+ * @param  {string}                   options.cacheDir  Cache directory path. Defaults to "./cache"
+ * @param  {boolean}                  options.glob      If true, file globbing is enabled. Defaults to false.
+ * @param  {string[]}                 options.argv      Arguments to pass to NW.js. Defaults to []. See [NW.js CLI options](https://docs.nwjs.io/en/latest/References/Command%20Line%20Options/#command-line-options) for more information.
+ * @return {Promise<void>}
+ */
+export async function run({
+  version = "latest",
+  flavor = "normal",
+  platform = PLATFORM_KV[PLATFORM],
+  arch = ARCH_KV[ARCH],
+  srcDir = "./src",
+  cacheDir = "./cache",
+  glob = false,
+  argv = [],
+}) {
+  try {
+    if (EXE_NAME[platform] === undefined) {
+      throw new Error("Unsupported platform.");
+    }
+    if (glob === true) {
+      throw new Error("Globbing is not supported with run mode.");
+    }
+
+    const nwDir = resolve(
+      cacheDir,
+      `nwjs${flavor === "sdk" ? "-sdk" : ""}-v${version}-${platform}-${arch}`,
+    );
+
+    return new Promise((res, rej) => {
+      // It is assumed that the package.json is located at srcDir/package.json
+      const nwProcess = spawn(
+        resolve(nwDir, EXE_NAME[platform]),
+        [srcDir.concat(argv)],
+        {
+          detached: true,
+          windowsHide: true,
+        },
+      );
+
+      nwProcess.on("close", () => {
+        res();
+      });
+
+      nwProcess.on("error", (error) => {
+        log.error(error);
+        rej(error);
+      });
+    });
+  } catch (error) {
+    log.error(error);
+  }
+}

package/src/util/ffmpeg.js

@@ -9,22 +9,25 @@ import { resolve } from "node:path";
  * @param {string} ffmpegFile  The path to the ffmpeg file to replace with
  */
 export const replaceFfmpeg = async (platform, nwDir, ffmpegFile) => {
+  const src = resolve(nwDir, ffmpegFile);
   if (platform === "linux") {
-    await copyFile(ffmpegFile, resolve(nwDir, "lib", ffmpegFile));
+    const dest = resolve(nwDir, "lib", ffmpegFile);
+    await copyFile(src, dest);
   } else if (platform === "win") {
-    await copyFile(ffmpegFile, resolve(nwDir, ffmpegFile));
+    // don't do anything for windows because the extracted file is already in the correct path
+    // await copyFile(src, resolve(nwDir, ffmpegFile));
   } else if (platform === "osx") {
-    await copyFile(
+    const dest = resolve(
+      nwDir,
+      "nwjs.app",
+      "Contents",
+      "Frameworks",
+      "nwjs Framework.framework",
+      "Versions",
+      "Current",
       ffmpegFile,
-      resolve(
-        nwDir,
-        "Contents",
-        "Frameworks",
-        "nwjs Framework.framework",
-        "Versions",
-        "Current",
-        ffmpegFile,
-      ),
     );
+
+    await copyFile(src, dest);
   }
 };

package/src/util.js

@@ -83,3 +83,21 @@ export async function getReleaseInfo(
   }
   return releaseData;
 }
+
+export const PLATFORM_KV = {
+  darwin: "osx",
+  linux: "linux",
+  win32: "win",
+};
+
+export const ARCH_KV = {
+  x64: "x64",
+  ia32: "ia32",
+  arm64: "arm64",
+};
+
+export const EXE_NAME = {
+  win: "nw.exe",
+  osx: "nwjs.app/Contents/MacOS/nwjs",
+  linux: "nw",
+};

package/src/run/develop.js

@@ -1,34 +0,0 @@
-import { execute } from "./execute.js";
-import { getPlatformSpecificName } from "./getPlatformSpecificName.js";
-
-import { log } from "../log.js";
-
-/**
- * Runs the NW app by spawning a child process
- *
- * @param  {string}                  srcDir    The directory to run from
- * @param  {string}                  nwDir     The directory to run nw.js from
- * @param  {"win" | "osx" | "linux"} platform  The platform to run for
- * @param  {string[]}                argv      The arguments to pass to the nw.js development server
- * @param  {boolean}                 glob      If true then glob then globbing is enabled
- * @return {Promise<undefined>}
- */
-const develop = async (srcDir, nwDir, platform, argv, glob) => {
-  try {
-    if (getPlatformSpecificName(platform) === null) {
-      throw new Error("Unsupported platform.");
-    }
-    if (glob === true) {
-      throw new Error("Globbing is not supported by run mode.");
-    }
-    await execute(
-      srcDir,
-      `${nwDir}/${getPlatformSpecificName(platform)}`,
-      argv,
-    );
-  } catch (error) {
-    log.error(error);
-  }
-};
-
-export { develop };

package/src/run/execute.js

@@ -1,33 +0,0 @@
-import { spawn } from "node:child_process";
-
-import { log } from "../log.js";
-
-/**
- * Executes the NW.js process
- *
- * @param  {string}             srcDir  The source directory
- * @param  {string}             nwPath  The path to the NW.js executable
- * @param  {string}             argv    The arguments to pass to the NW.js process
- * @return {Promise<undefined>}         The exit code of the NW.js process
- * @throws {Error} - If the NW.js process fails to start
- */
-const execute = (srcDir, nwPath, argv) => {
-  return new Promise((resolve, reject) => {
-    // It is assumed that the package.jsonis located at srcDir/package.json
-    const nwProcess = spawn(nwPath, [srcDir.concat(argv)], {
-      detached: true,
-      windowsHide: true,
-    });
-
-    nwProcess.on("close", () => {
-      resolve();
-    });
-
-    nwProcess.on("error", (error) => {
-      log.error(error);
-      reject(error);
-    });
-  });
-};
-
-export { execute };

package/src/run/getPlatformSpecificName.js

@@ -1,20 +0,0 @@
-/**
- * Get platform specific name of the executable
- *
- * @param  {string} platform  - Platform
- * @return {string}           - Platform specific name
- */
-const getPlatformSpecificName = (platform) => {
-  switch (platform) {
-    case "linux":
-      return "nw";
-    case "osx":
-      return "nwjs.app/Contents/MacOS/nwjs";
-    case "win":
-      return "nw.exe";
-    default:
-      return null;
-  }
-};
-
-export { getPlatformSpecificName };