nw-builder 4.3.0 → 4.3.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nw-builder",
-  "version": "4.3.0",
+  "version": "4.3.2",
   "description": "Build NW.js desktop applications for MacOS, Windows and Linux.",
   "keywords": [
     "NW.js",
@@ -46,7 +46,8 @@
     "doc:bld": "vitepress build doc",
     "test:unit": "node --test-reporter=spec --test test/unit/index.js",
     "test:e2e": "node --test-reporter=spec --test test/e2e/index.js",
-    "test:demo": "cd test/fixture && node demo.js"
+    "test:mod": "cd test/fixture && node demo.js",
+    "test:cli": "cd test/fixture && nwbuild --platform win --arch x64 --outDir out --no-glob app"
   },
   "devDependencies": {
     "eslint": "^8.44.0",

package/src/bld/osxCfg.js

@@ -1,5 +1,5 @@
 import { platform } from "node:process";
-import fs from "node:fs/promises";
+import { copyFile, rename, readFile, writeFile } from "node:fs/promises";
 import { resolve } from "node:path";
 
 import plist from "plist";
@@ -9,6 +9,7 @@ import { log } from "../log.js";
 /**
  * @typedef {object}  OsxRc                      OSX resource configuration options
  * @property {string} name                        The name of the application
+ * @property {string} icon                        The path to the icon file. It should be a .icns file.
  * @property {string} LSApplicationCategoryType   The category that best describes your app for the App Store.
  * @property {string} CFBundleIdentifier          A unique identifier for a bundle usually in reverse DNS format.
  * @property {string} CFBundleName                A user-visible short name for the bundle.
@@ -33,14 +34,19 @@ const setOsxConfig = async (app, outDir) => {
       "MacOS apps built on Windows platform do not preserve all file permissions. See #716"
     );
   }
+
   try {
     const outApp = resolve(outDir, `${app.name}.app`);
-    await fs.rename(resolve(outDir, "nwjs.app"), outApp);
+    await rename(resolve(outDir, "nwjs.app"), outApp);
+    if (app.icon !== undefined) {
+      await copyFile(
+        resolve(app.icon),
+        resolve(outApp, "Contents", "Resources", "app.icns")
+      );
+    }
 
-    const infoPlistPath = resolve(outApp, "Contents/Info.plist");
-    const infoPlistJson = plist.parse(
-      await fs.readFile(infoPlistPath, "utf-8")
-    );
+    const infoPlistPath = resolve(outApp, "Contents", "Info.plist");
+    const infoPlistJson = plist.parse(await readFile(infoPlistPath, "utf-8"));
 
     infoPlistJson.LSApplicationCategoryType = app.LSApplicationCategoryType;
     infoPlistJson.CFBundleIdentifier = app.CFBundleIdentifier;
@@ -50,7 +56,6 @@ const setOsxConfig = async (app, outDir) => {
     infoPlistJson.CFBundleVersion = app.CFBundleVersion;
     infoPlistJson.CFBundleShortVersionString = app.CFBundleShortVersionString;
     infoPlistJson.NSHumanReadableCopyright = app.NSHumanReadableCopyright;
-    infoPlistJson.CFBundleIconFile = app.CFBundleIconFile;
 
     Object.keys(infoPlistJson).forEach((option) => {
       if (infoPlistJson[option] === undefined) {
@@ -58,7 +63,7 @@ const setOsxConfig = async (app, outDir) => {
       }
     });
 
-    await fs.writeFile(infoPlistPath, plist.build(infoPlistJson));
+    await writeFile(infoPlistPath, plist.build(infoPlistJson));
   } catch (error) {
     log.error(error);
   }

package/src/cli.js

@@ -32,6 +32,42 @@ const cli = yargs(hideBin(process.argv))
     type: "string",
     description: "NW.js build artifacts",
   })
+  .option("cacheDir", {
+    type: "string",
+    description: "Cache NW.js binaries",
+  })
+  .option("downloadUrl", {
+    type: "string",
+    description: "NW.js download server",
+  })
+  .option("manifestUrl", {
+    type: "string",
+    description: "NW.js version info",
+  })
+  .option("glob", {
+    type: "boolean",
+    description: "Flag to enable/disable globbing",
+  })
+  .option("app", {
+    type: "object",
+    description: "Platform specific app metadata. Refer to docs for more info",
+  })
+  .option("cache", {
+    type: "boolean",
+    description: "Flag to enable/disable caching",
+  })
+  .option("zip", {
+    type: "string",
+    description: "Flag to enable/disable compression",
+  })
+  .option("ffmpeg", {
+    type: "string",
+    description: "Flag to enable/disable downloading community ffmpeg",
+  })
+  .option("logLevel", {
+    type: "string",
+    description: "Specify log level",
+  })
   .parse();
 
 nwbuild({

package/src/index.js

@@ -14,7 +14,6 @@ import { getFiles } from "./util/files.js";
 import { getVersionManifest } from "./util/versionManifest.js";
 import { parse } from "./util/parse.js";
 import { validate } from "./util/validate.js";
-import { xattr } from "./util/xattr.js";
 
 import { log, setLogLevel } from "./log.js";
 
@@ -182,8 +181,6 @@ const nwbuild = async (options) => {
       }
     }
 
-    await xattr(options.platform, options.arch, nwDir);
-
     // Downloading binaries is required for run and build modes
     // If mode is get, exit function since we have gotten the binaries
     if (options.mode === "get") {

package/src/util/parse.js

@@ -43,6 +43,7 @@ export const parse = async (options, pkg) => {
 
   options.app = options.app ?? {};
   options.app.name = options.app.name ?? pkg.name;
+  options.app.icon = options.app.icon ?? undefined;
 
   // TODO(#737): move this out
   if (options.platform === "linux") {
@@ -50,7 +51,6 @@ export const parse = async (options, pkg) => {
     options.app.genericName = options.app.genericName ?? undefined;
     options.app.noDisplay = options.app.noDisplay ?? undefined;
     options.app.comment = options.app.comment ?? undefined;
-    options.app.icon = options.app.icon ?? undefined;
     options.app.hidden = options.app.hidden ?? undefined;
     options.app.onlyShowIn = options.app.onlyShowIn ?? undefined;
     options.app.notShowIn = options.app.notShowIn ?? undefined;

package/src/util/xattr.js

@@ -1,30 +0,0 @@
-import { exec } from "node:child_process";
-import { resolve } from "node:path";
-
-import { log } from "../log.js";
-
-/**
- * Remove the quarantine attribute from the app bundle
- *
- * @param  {string}        platform  - The platform to build for
- * @param  {string}        arch      - The arch to build for
- * @param  {string}        nwDir     - The path to the nw directory
- * @return {Promise<void>}           - A promise that resolves when the attribute is removed
- */
-export const xattr = (platform, arch, nwDir) => {
-  return new Promise((res, rej) => {
-    if (platform === "osx" && arch === "arm64") {
-      let app = resolve(nwDir, "nwjs.app");
-      exec(`sudo xattr -d com.apple.quarantine ${app}`, (err, stdout) => {
-        log.debug(stdout);
-        if (err) {
-          rej(err);
-        } else {
-          res();
-        }
-      });
-    } else {
-      res();
-    }
-  });
-};