nw 0.85.0-3-sdk → 0.85.0-4-sdk

package/README.md

@@ -78,23 +78,6 @@ Add a script in your `package.json`:
 
 Executing `npm start` runs the NW.js app. Omitting the file path makes NW.js check for valid project in current working directory. You can also call `nw` directly from `node_modules/.bin/nw`.
 
-## Command Line Options
-
-There are a few (platform-specific) arguments you can pass to the `nw` executable to customize your nw.js application:
-
-* `--mac_plist <path-to-plist-file>`: (OS X only) Copies the given file to Info.plist in the app
-  bundle. This lets you do things like change your app's name and point to a different icon.
-
-* `--mac_icon <path-to-icns-file>`: (OS X only) Copies the given .icns file to the Resources/ dir
-  in the app bundle. You will need to point to the file with a custom plist file as well (see
-  `--mac_list`)
-
-**NOTE**: These options will keep the copied files in the app bundle for as long as the bundle is
-on the filesystem (they're not deleted between app invocations). As a result, they're not
-recommended if you installed nw globally using `-g`.  Also note that
-[OS X caches these files](http://proteo.me.uk/2011/08/mac-application-bundle-caching/),
-so you may need to manually clear these cached files during development.
-
 ## APIs
 
 ### Find path to the NW.js binary:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nw",
-  "version": "0.85.0-3-sdk",
+  "version": "0.85.0-4-sdk",
   "description": "An installer for nw.js",
   "repository": {
     "type": "git",
@@ -9,7 +9,7 @@
   "type": "module",
   "main": "src/index.js",
   "bin": {
-    "nw": "bin/nw.js"
+    "nw": "src/cli.js"
   },
   "scripts": {
     "postinstall": "node src/postinstall.js",
@@ -34,6 +34,7 @@
   "license": "MIT",
   "dependencies": {
     "axios": "^1.6.8",
+    "commander": "^12.0.0",
     "semver": "^7.5.4",
     "tar": "^6.2.1",
     "yargs": "^17.7.2",

package/src/cli.js

@@ -0,0 +1,35 @@
+#!/usr/bin/env node
+
+import process from 'node:process';
+
+import { program } from 'commander';
+
+import parse from '../src/parse.js';
+import run from '../src/run.js';
+
+await cli();
+
+async function cli() {
+
+  program
+    .option('--version <string>')
+    .option('--flavor <flavor>')
+    .option('--platform <platform>')
+    .option('--arch <arch>')
+    .option('--cacheDir <cacheDir>')
+    .argument('<app>')
+    .parse(process.argv);
+
+  let options = program.opts();
+  options = await parse(options);
+
+  await run({
+    version: options.version,
+    flavor: options.flavor,
+    platform: options.platform,
+    arch: options.arch,
+    cacheDir: options.cacheDir,
+    srcDir: program.args[0],
+  });
+
+}

package/src/index.js

@@ -1,4 +1,5 @@
 import get from './get.js';
+import run from './run';
 import util from './util.js';
 
 const { findpath } = util;
@@ -6,4 +7,5 @@ const { findpath } = util;
 export {
     findpath,
     get,
+    run,
 }

package/src/parse.js

@@ -0,0 +1,65 @@
+import process from 'node:process';
+
+import semver from 'semver';
+
+import nodeManifest from '../package.json' assert { type: 'json' };
+import util from '../src/util.js';
+
+/**
+ * @typedef {object} ParseOptions
+ * @property {string | "latest" | "stable" | "lts"} version                  Runtime version
+ * @property {"normal" | "sdk"}                     flavor                  Build flavor
+ * @property {"linux" | "osx" | "win"}              platform                            Target platform
+ * @property {"ia32" | "x64" | "arm64"}             arch                                Target arch
+ * @property {string}                               downloadUrl  Download server.
+ * @property {string}                               cacheDir                Cache 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
+ */
+
+/**
+ * Parse options.
+ * 
+ * @param {ParseOptions} options 
+ * @return {Promise<ParseOptions>}
+ */
+export default async function parse(options) {
+    options.version = options.version ?? nodeManifest.version;
+    const parsedVersion = semver.parse(options.version);
+    options.version = [
+        parsedVersion.major,
+        parsedVersion.minor,
+        parsedVersion.patch
+    ].join('.');
+
+    options.flavor = options.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);
+        }
+        options.version = [version, ...prerelease].join('-');
+    }
+
+    /* Check build flavor and slice that off the `version`. */
+    if (options.version.endsWith('-sdk')) {
+        options.version = options.version.slice(0, -4);
+        options.flavor = 'sdk';
+    } else if (options.version.endsWith('sdk')) {
+        options.version = version.slice(0, -3);
+        options.flavor = 'sdk';
+    }
+
+    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 || '.';
+    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;
+
+    return { ...options };
+}

package/src/run.js

@@ -13,8 +13,6 @@ 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}                              [glob = false]          If true, throw error
- * @property {string[]}                             [argv = []]             CLI arguments
  */
 
 /**
@@ -31,18 +29,14 @@ async function run({
   flavor = "normal",
   platform = util.PLATFORM_KV[process.platform],
   arch = util.ARCH_KV[process.arch],
-  srcDir = "./src",
+  srcDir = ".",
   cacheDir = "./cache",
-  glob = false,
-  argv = [],
 }) {
+
   try {
     if (util.EXE_NAME[platform] === undefined) {
       throw new Error("Unsupported platform.");
     }
-    if (glob === true) {
-      throw new Error("Globbing is not supported with run mode.");
-    }
 
     const nwDir = path.resolve(
       cacheDir,
@@ -50,14 +44,9 @@ async function run({
     );
 
     return new Promise((res, rej) => {
-      // It is assumed that the package.json is located at srcDir/package.json
       const nwProcess = child_process.spawn(
         path.resolve(nwDir, util.EXE_NAME[platform]),
-        [...[srcDir], ...argv],
-        {
-          detached: true,
-          windowsHide: true,
-        },
+        [srcDir]
       );
 
       nwProcess.on("close", () => {

package/src/util.js

@@ -8,7 +8,7 @@ const __dirname = path.dirname(url.fileURLToPath(import.meta.url));
 /**
  * Check if file exists at specified path.
  *
- * @param  {NodeJS.fs.}           filePath  - File path to check existence of
+ * @param  {fs.PathLike}           filePath  - File path to check existence of
  * @return {Promise<boolean>}           `true` if exists, otherwise `false`
  */
 async function fileExists(filePath) {

package/bin/nw.js

@@ -1,60 +0,0 @@
-#!/usr/bin/env node
-
-import { spawn } from 'node:child_process';
-import { existsSync, renameSync } from 'node:fs';
-import { dirname, resolve } from 'node:path';
-import { platform, argv, nextTick, exit, execPath } from 'node:process';
-import { fileURLToPath } from 'node:url';
-
-import { copyAssets } from '../lib/app_assets.js';
-import util from '../src/util.js';
-
-const __dirname = dirname(fileURLToPath(import.meta.url));
-
-function run() {
-  // Rename nw.js's own package.json as workaround for https://github.com/nwjs/nw.js/issues/1503
-  var packagejson = resolve(__dirname, '..', 'package.json');
-  var packagejsonBackup = resolve(__dirname, '..', 'package_backup.json');
-  if (!existsSync(packagejsonBackup)) {
-    try {
-      renameSync(packagejson, packagejsonBackup);
-    } catch (err) { }
-  }
-
-  // copy over any asset files (icons, etc) specified via CLI args:
-  copyAssets(platform, util.findpath());
-
-  // Normalize cli args
-  var args = argv.slice(2);
-  var cwd = (args.length < 1) ? '.' : args[0];
-  if (!existsSync(resolve(cwd))) {
-    args = ['.'].concat(args);
-  } else {
-    args = [cwd].concat(args.slice(1));
-  }
-
-  // Spawn node-webkit
-  var nw = spawn(util.findpath(), args, { stdio: 'inherit' });
-  nw.on('close', function () {
-    nextTick(function () {
-      exit(0);
-    });
-  });
-
-  // Restore package.json shortly after nw is spawned
-  setTimeout(function () {
-    try {
-      if (existsSync(packagejsonBackup)) {
-        renameSync(packagejsonBackup, packagejson);
-      }
-    } catch (err) { }
-  }, 1000);
-}
-
-if (!existsSync(util.findpath())) {
-  console.log('nw.js appears to have failed to download and extract. Attempting to download and extract again...');
-  var child = spawn(execPath, [resolve(__dirname, '..', 'src', 'postinstall.js')], { stdio: 'inherit' });
-  child.on('close', run);
-} else {
-  run();
-}

package/lib/app_assets.js

@@ -1,32 +0,0 @@
-import fs from 'node:fs';
-import path from 'node:path';
-
-import yargs from 'yargs';
-
-const argv = yargs(process.argv.slice(2)).argv;
-
-// Helper to simulate the shell's "cp" command
-function copyFileSync(srcFile, destFile) {
-  let content = fs.readFileSync(srcFile);
-  fs.writeFileSync(destFile, content);
-}
-
-// Copy asset files (specified via process.argv) over to the app binary's folder
-export function copyAssets(platform, binPath) {
-  // OS X: Save a custom plist file to Contents/Info.plist in the
-  // app bundle. This lets you customize things like the app's menubar
-  // name and icon (see argv.mac_icon below)
-  if (argv.mac_plist && platform === 'darwin') {
-    let plistPath = path.join(binPath, '..', '..', 'Info.plist');
-    copyFileSync(argv.mac_plist, plistPath);
-  }
-
-  // OS X: Save icon files to the Resources dir in the app bundle.
-  // Note that for the icon to work properly you need to point to
-  // it with a custom plist file.
-  if (argv.mac_icon && platform === 'darwin') {
-    let iconName = path.basename(argv.mac_icon);    // Preserve the file's name
-    let iconPath = path.join(binPath, '..', '..', 'Resources', iconName);
-    copyFileSync(argv.mac_icon, iconPath);
-  }
-}