nw-builder 4.11.4 → 4.11.5

package/README.md

@@ -5,15 +5,13 @@
 
 Build [NW.js](https://github.com/nwjs/nw.js) applications for Mac, Windows and Linux.
 
-For version 3, please go to the [corresponding branch](https://github.com/nwutils/nw-builder/tree/v3).
-
 ## Major Features
 
 - Get, run or build applications.
 - Integrate [FFmpeg community builds](https://github.com/nwjs-ffmpeg-prebuilt/nwjs-ffmpeg-prebuilt)
 - Configure executable fields and icons
 - Downloading from mirrors
-- Node Native Addon support
+- Node Native Addon support (partial)
 
 ## Table of Contents
 
@@ -30,19 +28,19 @@ For version 3, please go to the [corresponding branch](https://github.com/nwutil
 ## Install
 
 ```shell
-npm i -D nw nw-builder base-volta-off-of-nwjs
+npm i -D nw-builder
 ```
 
 Every NW.js release includes a modified Node.js binary at a specific version. It is recommended to [install](https://nodejs.org/en/download/package-manager) exactly that version on the host system. Not doing so may download ABI incompatible Node modules. Consult the NW.js [versions manifest](https://nwjs.io/versions) for what Node.js version to install. It is recommended to use a Node version manager (such as [volta](https://volta.sh), n, nvm, or nvm-windows) to be able to easily install and switch between Node versions.
 
 ## Usage
 
-This package can be used via a command line interface, be imported as a JavaScript module, or configured via the Node manifest as a JSON object.
+This package can be used via a command line interface, be imported as a JavaScript module, or configured via the Node manifest as a JSON object. If options are defined in Node manifest, then they will be used over options defined in CLI or JavaScript API.
 
 CLI interface:
 
 ```shell
-nwbuild --mode=build --glob=false --flavor=sdk --cacheDir=./node_modules/nw
+nwbuild --mode=build --glob=false --flavor=sdk --cacheDir=./node_modules/nw /path/to/project
 ```
 
 ESM import:
@@ -68,6 +66,7 @@ nwbuild({
   glob: false,
   flavor: "sdk",
   cacheDir: "./node_modules/nw",
+  srcDir: "/path/to/project",
 });
 ```
 
@@ -80,6 +79,7 @@ Node manifest usage:
       "glob": false,
       "flavor": "sdk",
       "cacheDir": "./node_modules/nw",
+      "srcDir": "/path/to/project"
     }
 }
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nw-builder",
-  "version": "4.11.4",
+  "version": "4.11.5",
   "description": "Build NW.js desktop applications for MacOS, Windows and Linux.",
   "keywords": [
     "NW.js",
@@ -48,7 +48,7 @@
     "test:cov": "vitest --coverage.enabled true",
     "demo:bld": "node ./tests/fixtures/demo.js",
     "demo:exe": "./tests/fixtures/out/nwapp.app/Contents/MacOS/nwapp",
-    "demo:cli": "nwbuild --mode run ./src ./app/**"
+    "demo:cli": "nwbuild --mode=run --version=0.92.0 --flavor=sdk --glob=false --cacheDir=./node_modules/nw ./tests/fixtures/app"
   },
   "devDependencies": {
     "@eslint/js": "^9.12.0",
@@ -57,7 +57,7 @@
     "eslint": "^9.12.0",
     "eslint-plugin-jsdoc": "^50.3.2",
     "globals": "^15.11.0",
-    "nw": "^0.92.0",
+    "nw": "^0.93.0",
     "selenium-webdriver": "^4.25.0",
     "vitest": "^2.0.4"
   },

package/src/cli.js

@@ -5,23 +5,24 @@ import { program } from 'commander';
 import nwbuild from './index.js';
 
 program
-  .option('--mode', 'get, run or build mode')
-  .option('--version', 'NW.js version')
-  .option('--flavor', 'NW.js build flavor')
-  .option('--platform', 'NW.js supported platform')
-  .option('--arch', 'NW.js supported architecture')
-  .option('--downloadUrl', 'NW.js download server')
-  .option('--manifestUrl', 'NW.js version info')
-  .option('--cacheDir', 'Cache NW.js binaries')
-  .option('--outDir', 'NW.js build artifacts')
-  .option('--app', 'Platform specific app metadata. Refer to docs for more info')
-  .option('--cache', 'Flag to enable/disable caching')
-  .option('--ffmpeg', 'Flag to enable/disable downloading community ffmpeg')
-  .option('--glob', 'Flag to enable/disable globbing')
-  .option('--logLevel', 'Specify log level')
-  .option('--zip', 'Flag to enable/disable compression')
-  .option('--managedManifest', 'Managed manifest mode')
-  .option('--nodeAddon', 'Download NW.js Node headers');
+  .argument('<string>', 'File path(s) to project')
+  .option('--mode <string>', 'get, run or build mode', 'build')
+  .option('--version <string>', 'NW.js version', 'latest')
+  .option('--flavor <string>', 'NW.js build flavor', 'normal')
+  .option('--platform <string>', 'NW.js supported platform')
+  .option('--arch <string>', 'NW.js supported architecture')
+  .option('--downloadUrl <string>', 'NW.js download server')
+  .option('--manifestUrl <string>', 'NW.js version info')
+  .option('--cacheDir <string>', 'Cache NW.js binaries')
+  .option('--outDir <string>', 'NW.js build artifacts')
+  .option('--app <object>', 'Platform specific app metadata. Refer to docs for more info')
+  .option('--cache <boolean>', 'Flag to enable/disable caching', true)
+  .option('--ffmpeg <boolean>', 'Flag to enable/disable downloading community ffmpeg', false)
+  .option('--glob <boolean>', 'Flag to enable/disable globbing', true)
+  .option('--logLevel <string>', 'Specify log level')
+  .option('--zip <string>', 'Flag to enable/disable compression', false)
+  .option('--managedManifest <string>', 'Managed manifest mode', false)
+  .option('--nodeAddon <boolean>', 'Download NW.js Node headers', false);
 
 program.parse();
 

package/src/util.js

@@ -161,6 +161,24 @@ async function getNodeManifest({
   return manifest;
 }
 
+/**
+ * Function to convert `'true'` and `'false'` into `true` and `false`.
+ * `commander` does not do the conversion automatically. 
+ * @param {any} option - a boolean type option
+ * @returns {any} Usually `undefined`, `true` or `false`. if not then it is validated later on.
+ */
+function str2Bool (option) {
+  if (typeof option === 'string') {
+    if (option === 'true') {
+      return true;
+    } else if (option === 'false') {
+      return false;
+    } 
+  } else {
+    return option;
+  } 
+}
+
 /**
  * Parse options.
  * @param  {import("../../index.js").Options} options  Options
@@ -178,8 +196,8 @@ export const parse = async (options, pkg) => {
   options.downloadUrl = options.downloadUrl ?? 'https://dl.nwjs.io';
   options.manifestUrl = options.manifestUrl ?? 'https://nwjs.io/versions';
   options.cacheDir = options.cacheDir ?? './cache';
-  options.cache = options.cache ?? true;
-  options.ffmpeg = options.ffmpeg ?? false;
+  options.cache = str2Bool(options.cache ?? true);
+  options.ffmpeg = str2Bool(options.ffmpeg ?? false);
   options.logLevel = options.logLevel ?? 'info';
 
   if (options.mode === 'get') {
@@ -187,7 +205,7 @@ export const parse = async (options, pkg) => {
   }
 
   options.argv = options.argv ?? [];
-  options.glob = options.glob ?? true;
+  options.glob = str2Bool(options.glob) ?? true;
   options.srcDir = options.srcDir ?? (options.glob ? './*' : '.');
 
   if (options.mode === 'run') {
@@ -195,10 +213,10 @@ export const parse = async (options, pkg) => {
   }
 
   options.outDir = path.resolve(options.outDir ?? './out');
-  options.zip = options.zip ?? false;
+  options.zip = str2Bool(options.zip) ?? false;
 
-  options.managedManifest = options.managedManifest ?? false;
-  options.nativeAddon = options.nativeAddon ?? false;
+  options.managedManifest = str2Bool(options.managedManifest) ?? false;
+  options.nativeAddon = str2Bool(options.nativeAddon) ?? false;
 
   options.app = options.app ?? {};
   options.app.name = options.app.name ?? pkg.name;