nw 0.87.0 → 0.88.0

package/README.md

@@ -6,6 +6,8 @@ An npm installer for [NW.js](https://nwjs.io).
 
 ## Install
 
+Please go through the [CHANGELOG](https://github.com/nwjs/npm-installer/blob/main/CHANGELOG.md) carefully and choose the appropriate version. Bug fixes and feature updates are pushed to the repo periodically.
+
 ### Latest version globally
 
 ```shell
@@ -64,6 +66,10 @@ Set `nwjs_native_addon` in `.npmrc` or `NWJS_NATIVE_ADDON` environment variable
 
 Set `nwjs_urlbase` in `.npmrc`or `NWJS_URLBASE` environment variable. Defaults to `https://dl.nwjs.io`. The file system (`file://`) is also supported (for example, `file:///home/localghost/local_mirror`).
 
+### Specify unref flag
+
+Set `nwjs_unref` in `.npmrc` or `NWJS_UNREF` environment variable. Default to `false`. This is useful if you're using `nw` package to call the executable and want to prevent zombie processes eating up memory.
+
 ## Usage
 
 Add a script in your `package.json`:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nw",
-  "version": "0.87.0",
+  "version": "0.88.0",
   "description": "An installer for nw.js",
   "repository": {
     "type": "git",
@@ -33,10 +33,10 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "axios": "^1.6.8",
-    "commander": "^12.0.0",
-    "semver": "^7.5.4",
-    "tar": "^7.0.1",
+    "axios": "^1.7.1",
+    "commander": "^12.1.0",
+    "semver": "^7.6.2",
+    "tar": "^7.1.0",
     "yauzl-promise": "^4.0.0"
   },
   "keywords": [
@@ -52,7 +52,7 @@
     "application"
   ],
   "devDependencies": {
-    "selenium-webdriver": "^4.18.1",
-    "vitest": "^1.5.0"
+    "selenium-webdriver": "^4.21.0",
+    "vitest": "^1.6.0"
   }
 }

package/src/cli.js

@@ -12,13 +12,13 @@ await cli();
 async function cli() {
 
   program
-    .option('--version <string>')
-    .option('--flavor <flavor>')
-    .option('--platform <platform>')
-    .option('--arch <arch>')
-    .option('--cacheDir <cacheDir>')
-    .argument('[app]')
-    .allowUnknownOption()
+    .argument('[app]', 'File path to project', '.')
+    .option('--version <string>', 'NW.js version')
+    .option('--flavor <flavor>', 'NW.js flavor')
+    .option('--platform <platform>', 'Host platform')
+    .option('--arch <arch>', 'Host architecture')
+    .option('--cacheDir <cacheDir>', 'File path to cache directory')
+    .allowUnknownOption() // this allows chromium and node options to be passed through to the nwjs binary
     .parse(process.argv);
 
   let options = program.opts();
@@ -31,6 +31,7 @@ async function cli() {
     arch: options.arch,
     cacheDir: options.cacheDir,
     srcDir: program.args[0],
+    args: program.args.slice(1),
   });
 
 }

package/src/decompress.js

@@ -92,4 +92,5 @@ async function unzip(zippedFile, cacheDir) {
       await fs.promises.symlink(linkTarget, entryPathAbs);
     }
   }
+  await zip.close();
 }

package/src/parse.js

@@ -1,9 +1,10 @@
+import fs from 'node:fs';
 import path from 'node:path';
 import process from 'node:process';
+import url from 'node:url';
 
 import semver from 'semver';
 
-import nodeManifest from '../package.json' assert { type: 'json' };
 import util from '../src/util.js';
 
 /**
@@ -14,9 +15,11 @@ import util from '../src/util.js';
  * @property {"ia32" | "x64" | "arm64"}             arch                                Target arch
  * @property {string}                               downloadUrl  Download server.
  * @property {string}                               cacheDir                Cache directory
+ * @property {string}                               srcDir                  Source directory
  * @property {boolean}                              cache                        If false, remove cache and redownload.
  * @property {boolean}                              ffmpeg                      If true, ffmpeg is not downloaded.
- * @property {false | "gyp"}                        nativeAddon                 Rebuild native modules
+ * @property {false | "gyp"}                        nativeAddon                   Rebuild native modules
+ * @property {boolean}                              unref                         Unref the child process and unblock the caller
  */
 
 /**
@@ -26,6 +29,15 @@ import util from '../src/util.js';
  * @return {Promise<ParseOptions>}
  */
 export default async function parse(options) {
+    const __dirname = path.dirname(url.fileURLToPath(import.meta.url));
+    /**
+     * @type {fs.PathLike}
+     */
+    const nodeManifestPath = path.resolve(__dirname, '..', 'package.json');
+    /**
+     * @type {object}
+     */
+    const nodeManifest = JSON.parse(await fs.promises.readFile(nodeManifestPath, { encoding: 'utf-8' }));
     options.version = options.version ?? nodeManifest.version;
     const parsedVersion = semver.parse(options.version);
     options.version = [
@@ -57,10 +69,12 @@ export default async function parse(options) {
     options.platform = options.platform || util.PLATFORM_KV[process.env.npm_config_nwjs_platform || process.env.NWJS_PLATFORM || process.platform];
     options.arch = options.arch || util.ARCH_KV[process.env.npm_config_nwjs_process_arch || process.env.NWJS_ARCH || process.arch];
     options.downloadUrl = options.downloadUrl || process.env.npm_config_nwjs_urlbase || process.env.NWJS_URLBASE || 'https://dl.nwjs.io';
-    options.cacheDir = options.npm_config_nwjs_urlbase || process.env.npm_config_nwjs_cache_dir || process.env.NWJS_CACHE_DIR || path.resolve('.', 'node_modules', 'nw');
+    options.cacheDir = options.npm_config_nwjs_urlbase || process.env.npm_config_nwjs_cache_dir || process.env.NWJS_CACHE_DIR || path.resolve(__dirname, '..');
+    options.srcDir = options.srcDir || process.cwd();
     options.cache = options.cache || process.env.npm_config_nwjs_cache || process.env.NWJS_CACHE || true;
     options.ffmpeg = options.ffmpeg || process.env.npm_config_nwjs_ffmpeg || process.env.NWJS_FFMPEG || false;
     options.nativeAddon = options.nativeAddon || process.env.npm_config_nwjs_native_addon || process.env.NWJS_NATIVE_ADDON || false;
+    options.unref = options.unref || process.env.npm_config_nwjs_unref || process.env.NWJS_UNREF || false;
 
     return { ...options };
 }

package/src/postinstall.js

@@ -1,20 +1,32 @@
+import fs from 'node:fs';
 import process from 'node:process';
+import path from 'node:path';
+import url from 'node:url';
 
 import semver from 'semver';
 
 import get from './get.js';
 import util from './util.js';
 
-import nodeManifest from '../package.json' assert { type: 'json' };
-
 await postinstall()
     .catch((error) => {
         if (error.code === 'EPERM') {
             console.error('Unable to create symlink since user did not run as Administrator.');
+        } else {
+            console.error(error)
         }
     });
 
 async function postinstall() {
+    const __dirname = path.dirname(url.fileURLToPath(import.meta.url));
+    /**
+     * @type {fs.PathLike}
+     */
+    const nodeManifestPath = path.resolve(__dirname, '..', 'package.json');
+    /**
+     * @type {object}
+     */
+    const nodeManifest = JSON.parse(await fs.promises.readFile(nodeManifestPath));
     const parsedVersion = semver.parse(nodeManifest.version);
     let version = [
         parsedVersion.major,
@@ -23,21 +35,17 @@ async function postinstall() {
     ].join('.');
 
     let flavor = process.env.npm_config_nwjs_build_type || process.env.NWJS_BUILD_TYPE || 'normal';
-    /* Check if version is a prelease. */
-    if (typeof parsedVersion?.prerelease?.[0] === 'string') {
-        let prerelease = parsedVersion.prerelease[0].split('-');
-        if (prerelease.length > 1) {
-            prerelease = prerelease.slice(0, -1);
-        }
-        version = [version, ...prerelease].join('-');
-    }
 
+    /**
+     * If `parsedVersion` is `null`, then prerelease is `"null"`.
+     * If `parsedVersion?.prerelease` is `[]`, then prerelease is `"undefined"`.
+     * If `parsedVersion?.prerelease[0]` is `"N-sdk"` where N represents a build number, then prerelease is `"N-sdk"`.
+     *
+     * @type {"null" | "undefined" | "N-sdk" | ""}
+     */
+    const prerelease = String(parsedVersion?.prerelease[0]);
     /* Check build flavor and slice that off the `version`. */
-    if (version.endsWith('-sdk')) {
-        version = version.slice(0, -4);
-        flavor = 'sdk';
-    } else if (version.endsWith('sdk')) {
-        version = version.slice(0, -3);
+    if (prerelease.endsWith('-sdk')) {
         flavor = 'sdk';
     }
 

package/src/run.js

@@ -13,6 +13,8 @@ import util from "./util.js";
  * @property {"ia32" | "x64" | "arm64"}             [arch]                  Target arch
  * @property {string}                               [srcDir = "./src"]      Source directory
  * @property {string}                               [cacheDir = "./cache"]  Cache directory
+ * @property {boolean}                              [unref = false]         Unref the child process and unblock the caller
+ * @property {string[]}                             [args = []]             Command line arguments
  */
 
 /**
@@ -31,6 +33,8 @@ async function run({
   arch = util.ARCH_KV[process.arch],
   srcDir = ".",
   cacheDir = "./cache",
+  unref = false,
+  args = [],
 }) {
 
   try {
@@ -46,17 +50,26 @@ async function run({
     return new Promise((res, rej) => {
       const nwProcess = child_process.spawn(
         path.resolve(nwDir, util.EXE_NAME[platform]),
-        [srcDir]
+        [srcDir, ...args],
+        { detached: true, stdio: "ignore" },
       );
 
       nwProcess.on("close", () => {
         res();
       });
 
+      nwProcess.on("message", (message) => {
+        console.log(message);
+      });
+
       nwProcess.on("error", (error) => {
         console.error(error);
         rej(error);
       });
+
+      if (unref) {
+        nwProcess.unref();
+      }
     });
   } catch (error) {
     console.error(error);