nw-builder 3.8.7 → 3.8.9

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021-2023 NW.js Utilities
+Copyright (c) 2014-2021 Steffen Müller
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,7 +1,7 @@
 # nw-builder
 
-[![npm](https://img.shields.io/npm/v/nw-builder/stable)](https://www.npmjs.com/package/nw-builder)
-[![Join the chat at https://gitter.im/nwjs/nw-builder](https://badges.gitter.im/nwjs/nw-builder.svg)](https://gitter.im/nwjs/nw-builder?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![npm](https://img.shields.io/npm/v/nw-builder/stable)](https://www.npmjs.com/package/nw-builder/v/stable)
+[![Join the chat at https://gitter.im/nwjs/nw-builder](https://badges.gitter.im/repo.svg)](https://app.gitter.im/#/room/#nwjs_nw-builder:gitter.im)
 
 Build [NW.js](https://github.com/nwjs/nw.js) applications for Mac, Windows and Linux.
 
@@ -12,6 +12,7 @@ For version 4, please go to the [corresponding branch](https://github.com/nwutil
 - [Installation](https://github.com/nwutils/nw-builder#installation)
 - [Usage](https://github.com/nwutils/nw-builder#usage)
 - [API Reference](https://github.com/nwutils/nw-builder#api-reference)
+- [Migration Guide v3->v4](https://github.com/nwutils/nw-builder#migration)
 - [Contributing](https://github.com/nwutils/nw-builder#contributing)
 - [License](https://github.com/nwutils/nw-builder#license)
 
@@ -327,6 +328,209 @@ To get around it, run `ulimit -n 1024` (or add it to your `~/.bash_profile`). Fo
 
 This project was created by [Steffen Müller](https://github.com/steffenmllr) and has been maintained by [Gabe Paez](https://github.com/gabepaez), [Andy Trevorah](https://github.com/trevorah), [Adam Lynch](https://github.com/adam-lynch) and [Rémy Boulanouar](https://github.com/DblK) in the past. This project is currently maintained by [Ayushman Chhabra](https://github.com/ayushmxn).
 
+## Migration
+
+## Migration Guide (v3 -> v4)
+
+> We are working on making the migration process smoother. If you encounter any issues with the current guide, please open an issue or start a discussion.
+
+### Update `nw-builder`
+
+With npm:
+
+```shell
+npm update nw-builder@latest
+```
+
+With yarn:
+
+```shell
+yarn upgrade nw-builder@latest
+```
+
+With pnpm:
+
+```shell
+pnpm update nw-builder@latest
+```
+
+### Update options
+
+Let's take an example of v3 code and migrate it to v4.
+
+```javascript
+const NwBuilder = require("nw-builder");
+
+const nw = new NwBuilder({
+  files: ["./nwapp/**/*", "./other/**/*.js"],
+  version: "latest",
+  flavor: "normal",
+  platforms: ["win32", "win64", "osx32", "osx64", "linux32", "linux64"],
+  cacheDir: "./cache",
+  buildDir: "./build",
+  buildType: "versioned",
+  forceDownload: true,
+  appName: "nwdemo",
+  appVersion: "0.1.0",
+  argv: "--nw-stderr-logging",
+  macCredits: "./nwapp/credits.html",
+  macIcns: "./nwapp/mac.icns",
+  macPlist: { ... },
+  winVersionString: { ... },
+  winIco: "./nwapp/win.ico",
+  zip: true,
+  macZip: false,
+  mergeZip: false,
+});
+
+nw.build();
+```
+
+Update the import path
+
+```diff
+-const NwBuilder = require("nw-builder");
++const nwbuild = require("nw-builder");
+```
+
+Replace the `NwBuilder` initialization with a function
+
+```diff
+-const nw = new NwBuilder({
++await nwbuild({
+```
+
+The `files` property has been renamed to `srcDir`.
+
+```diff
+-  files: ["./nwapp/**/*", "./other/**/*.js"],
++  srcDir: "./nwapp/**/* ./other/**/*.js",
+```
+
+Add the `mode` option and remove the now redundant `nw.build` function call. The `build` call is made by `nwbuild` internally.
+
+```diff
++  mode: "build",
+
+-nw.build();
+```
+
+The `platforms` option has been removed and replaced with `platform` and `arch`. Notice that one `nwbuild` function call now creates one build for one platform and one arch only.
+
+```diff
+-  platforms: ["win32", "win64", "osx32", "osx64", "linux32", "linux64"],
++  platform: "linux", // "osx" for MacOS "win",  for Windows
++  arch: "x64", // "ia32" for 32 bit or "arm64" for arm based 65 bit architectures
+```
+
+The `buildDir` option has been rename to `outDir`.
+
+```diff
+-  buildDir: "./build",
++  outDir: "./build",
+```
+
+The `buildType` option has been removed.
+
+```diff
+-  buildType: "versioned",
+```
+
+The `forceDownload` option has been changed to `cache`.
+
+```diff
+-  forceDownload: true,
++  cache: false,
+```
+
+The `appName` option has been changed to `app.name`.
+
+```diff
+-  appName: "nwdemo",
++  app: { name: "nwdemo" },
+```
+
+The `appVersion` option has been changed to `app.version`.
+
+```diff
+-  appVersion: "0.1.0",
++  app: { version: "0.1.0" },
+```
+
+The `macCredit` option has been removed.
+
+```diff
+-  macCredits: "./nwapp/credits.html",
+```
+
+The `macIcns` option has been replaced with `icon`.
+
+```diff
+-  macIcns: "./nwapp/mac.icns",
++  icon: "./nwapp/mac.icns",
+```
+
+The `macPlist` option has been replaced by `app.*` options. Consult the [documentation](https://nwutils.io/nw-builder/mode-build.html#osxrc-object) for valid properties.
+
+```diff
+-  macPlist: { ... },
++  app: { ... },
+```
+
+The `winVersionString` option has been replaced with `app`. Consult the [documentation](https://nwutils.io/nw-builder/mode-build.html#winrc-object) for valid properties.
+
+```diff
+-  winVersionString: {
+-    'CompanyName': 'Some Company',
+-    'FileDescription': 'Process Name',
+-    'ProductName': 'Some Product',
+-    'LegalCopyright': 'Copyright 2017',
+-  }
++  app: {
++    company: "Some Company",
++    fileDescription: "Process Name",
++    productName: "Some Product",
++    legalCopyright: "Copyright (c) 2023",
++  }
+```
+
+The `winIco` option has been replaced by `app.icon`.
+
+```diff
+-  winIco: "./nwapp/win.ico",
++  app: { icon: "./nwapp/win.ico" },
+```
+
+The `macZip` option has been removed.
+
+```diff
+-  macZip: false,
+```
+
+The `mergeZip` option has been removed.
+
+```diff
+-  mergeZip: false,
+```
+
+The final code should look like this.
+
+```javascript
+const { nwbuild } = require("nw-builder");
+
+await nwbuild({
+  srcDir: "./nwapp/**/* ./other/**/*.js",
+  mode: "build",
+  version: "latest",
+  flavor: "normal",
+  platform: "linux",
+  arch: "x64",
+  outDir: "./build",
+  cache: false,
+  app: { ... },
+});
+```
+
 ## Contributing
 
 ### Getting Started

package/{bin/nwbuild.cjs → lib/cli.cjs}

@@ -3,7 +3,7 @@
 const yargs = require("yargs/yargs");
 const { hideBin } = require("yargs/helpers");
 
-const { nwbuild } = require("../lib/index.cjs");
+const { nwbuild } = require("./index.cjs");
 const { detectCurrentPlatform } = require("../dist/index.cjs");
 
 const cli = yargs(hideBin(process.argv))

package/lib/index.cjs

@@ -1,19 +1,19 @@
-const { basename, resolve } = require("node:path");
-const { version } = require("node:process");
-const { mkdir, cp, rm, rename } = require("node:fs/promises");
-const { readFileSync } = require("node:fs");
+const fs = require("node:fs");
+const path = require("node:path");
+const process = require("node:process");
+
+const _ = require("lodash");
 const glob = require("simple-glob");
-var _ = require("lodash");
-var fs = require("graceful-fs-extra");
-var path = require("path");
-var thenify = require("thenify");
-var rcedit = require("rcedit");
-var winresourcer = thenify(require("winresourcer"));
-var semver = require("semver");
-var platformOverrides = require("./platformOverrides.cjs");
+const gfs = require("graceful-fs-extra");
+const thenify = require("thenify");
+const rcedit = require("rcedit");
+const winresourcer = thenify(require("winresourcer"));
+const semver = require("semver");
+const platformOverrides = require("./platformOverrides.cjs");
+const NwVersions = require("./versions.cjs");
+const Utils = require("./utils.cjs");
 
 const {
-  checkCache,
   get,
   getReleaseInfo,
   isCached,
@@ -24,23 +24,20 @@ const {
   run,
   validate,
 } = require("../dist/index.cjs");
-var NwVersions = require("./versions.cjs");
-var Version = require("./Version.cjs");
-var Utils = require("./utils.cjs");
 
 class NwBuilder {
   constructor(options) {
     this.init(options).then(() => {
-      this._platforms = { ...Platforms };
-
-      // clear all unused platforms
-      for (const name in this._platforms) {
-        if (
-          this.options.platforms &&
-          this.options.platforms.indexOf(name) === -1
-        )
-          delete this._platforms[name];
+      /* Make a shallow copy of the Platforms object */
+      this.platforms = Object.assign({}, Platforms);
+      /* Clear all unused platforms */
+      for (const platform of Object.keys(this.platforms)) {
+        if (!options.platforms.includes(platform)) {
+          delete this.platforms[platform];
+        }
       }
+    }).catch((error) => {
+      console.error(error);
     });
   }
 
@@ -51,8 +48,8 @@ class NwBuilder {
       options = parse(options, manifest);
 
       for (const file of glob(options.files)) {
-        if (basename(file) === "package.json" && manifest === undefined) {
-          manifest = JSON.parse(readFileSync(file));
+        if (path.basename(file) === "package.json" && manifest === undefined) {
+          manifest = JSON.parse(fs.readFileSync(file));
         }
       }
 
@@ -96,7 +93,7 @@ class NwBuilder {
       if (options.quiet === "debug") {
         log.debug(`Platform: ${platform}`);
         log.debug(`Archicture: ${arch}`);
-        log.debug(`Node Version: ${version}`);
+        log.debug(`Node Version: ${process.version}`);
         log.debug(`NW.js Version: ${options.version}\n`);
       }
     } catch (error) {
@@ -201,84 +198,6 @@ class NwBuilder {
     });
   }
 
-  checkVersion() {
-    var version = this.options.version,
-      flavor =
-        semver.valid(version) && semver.satisfies(version, "<0.12.3")
-          ? "sdk"
-          : this.options.flavor,
-      self = this;
-
-    if (!semver.valid(version)) {
-      return Promise.reject("The version " + version + " is not valid.");
-    }
-
-    var getVersionFromManifest = function () {
-      return NwVersions.getVersion({
-        desiredVersion: version,
-        downloadUrl: self.options.downloadUrl,
-        manifestUrl: self.options.manifestUrl,
-        flavor: flavor,
-      });
-    };
-    var getVersion;
-
-    // if the user specified the exact version and all its platforms are cached, don't hit the manifest at all;
-    // just trust the ones are cached and assume they're supported
-    if (self.options.version !== "latest") {
-      var areAllPlatformsCached = true;
-      this._forEachPlatform(function (name, platform) {
-        var platformToCheck = platform;
-
-        if (semver.satisfies(self.options.version, ">=0.12.3")) {
-          platformToCheck = _.clone(platform);
-          platformToCheck.files = ["*"]; // otherwise it'll try to check cache legacy version files
-        }
-
-        if (
-          !self.isPlatformCached(
-            name,
-            platformToCheck,
-            self.options.version,
-            flavor,
-          )
-        ) {
-          areAllPlatformsCached = false;
-        }
-      });
-      if (areAllPlatformsCached) {
-        getVersion = Promise.resolve(
-          new Version({
-            version: version,
-            flavors: [flavor],
-            downloadUrl: self.options.downloadUrl,
-            supportedPlatforms: Object.keys(this._platforms),
-          }),
-        );
-      } else {
-        // otherwise hit the manifest
-        getVersion = getVersionFromManifest();
-      }
-    } else {
-      // otherwise hit the manifest
-      getVersion = getVersionFromManifest();
-    }
-
-    return getVersion.then(function (version) {
-      self._version = version;
-      self._version.flavor = flavor;
-      log.debug(
-        "Using v" +
-          self._version.version +
-          " (" +
-          (self._version.flavor === "" ? "normal" : self._version.flavor + ")"),
-      );
-      if (self._version.isLegacy) {
-        log.warn("NW.js / node-webkit versions <0.12.3 are deprecated.");
-      }
-    });
-  }
-
   platformFilesForVersion() {
     var self = this;
 
@@ -313,7 +232,7 @@ class NwBuilder {
 
     built = await isCached(options.cacheDir);
     if (built === false) {
-      await mkdir(options.cacheDir, { recursive: true });
+      await fs.promises.mkdir(options.cacheDir, { recursive: true });
     }
     for await (const os of options.platforms) {
       const platform = os.slice(0, os.length - 2);
@@ -416,10 +335,10 @@ class NwBuilder {
           );
 
           // Ensure that there is a release Folder, delete and create it.
-          fs.remove(platform.releasePath, function (err) {
+          gfs.remove(platform.releasePath, function (err) {
             if (err) return reject(err);
 
-            fs.mkdirp(platform.releasePath, function (err) {
+            gfs.mkdirp(platform.releasePath, function (err) {
               if (err) return reject(err);
 
               log.debug("Create release folder in " + platform.releasePath);
@@ -438,28 +357,28 @@ class NwBuilder {
       const platform = os.slice(0, os.length - 2);
       const arch = "x" + os.slice(os.length - 2);
 
-      await rm(resolve(this.options.buildDir, this.options.appName, os), {
+      await fs.promises.rm(path.resolve(this.options.buildDir, this.options.appName, os), {
         recursive: true,
         force: true,
       });
 
-      const nwDir = resolve(
+      const nwDir = path.resolve(
         this.options.cacheDir,
         `nwjs${this.options.flavor === "sdk" ? "-sdk" : ""}-v${
           this.options.version
         }-${platform}-${arch}`,
       );
 
-      await cp(
+      await fs.promises.cp(
         nwDir,
-        resolve(this.options.buildDir, this.options.appName, os),
+        path.resolve(this.options.buildDir, this.options.appName, os),
         { recursive: true },
       );
 
       for (const file of glob(this.options.files)) {
-        await cp(
+        await fs.promises.cp(
           file,
-          resolve(
+          path.resolve(
             this.options.buildDir,
             this.options.appName,
             os,
@@ -546,7 +465,7 @@ class NwBuilder {
               self._files,
               self,
               JSON.stringify(
-                self._platforms[platformName].platformSpecificManifest,
+                self.platforms[platformName].platformSpecificManifest,
               ),
               zipOptions,
             ).then(function (file) {
@@ -657,9 +576,9 @@ class NwBuilder {
 
       var executableName = self.getExecutableName(name);
 
-      await rename(
-        resolve(platform.releasePath, "nw"),
-        resolve(platform.releasePath, executableName),
+      await fs.promises.rename(
+        path.resolve(platform.releasePath, "nw"),
+        path.resolve(platform.releasePath, executableName),
       );
     });
   }
@@ -673,9 +592,9 @@ class NwBuilder {
 
       var executableName = self.getExecutableName(name);
 
-      await rename(
-        resolve(platform.releasePath, "nwjs.app"),
-        resolve(platform.releasePath, executableName),
+      await fs.promises.rename(
+        path.resolve(platform.releasePath, "nwjs.app"),
+        path.resolve(platform.releasePath, executableName),
       );
 
       // Let's first handle the mac icon
@@ -769,9 +688,9 @@ class NwBuilder {
       var executableName = self.getExecutableName(name);
       var executablePath = path.resolve(platform.releasePath, executableName);
 
-      await rename(
-        resolve(platform.releasePath, "nw.exe"),
-        resolve(platform.releasePath, executableName),
+      await fs.promises.rename(
+        path.resolve(platform.releasePath, "nw.exe"),
+        path.resolve(platform.releasePath, executableName),
       );
 
       var rcConf = {};
@@ -861,7 +780,7 @@ class NwBuilder {
   }
 
   _forEachPlatform(fn) {
-    _.forEach(this._platforms, function (platform, name) {
+    _.forEach(this.platforms, function (platform, name) {
       return fn(name, platform);
     });
   }
@@ -899,15 +818,6 @@ class NwBuilder {
     }
   }
 
-  isPlatformCached(platformName, platform, version, flavor) {
-    this.setPlatformCacheDirectory(platformName, platform, version, flavor);
-    if (this.options.forceDownload) {
-      return false;
-    }
-    this.preparePlatformFiles(platformName, platform, version);
-    return checkCache(platform.cache, platform.files);
-  }
-
   // returns a Boolean; true if the desired platform is supported
   preparePlatformFiles(platformName, platform, version) {
     // return if platform.files is already prepared

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nw-builder",
-  "version": "3.8.7",
+  "version": "3.8.9",
   "description": "Build NW.js desktop applications for Mac, Windows and Linux.",
   "keywords": [
     "NW.js",
@@ -27,11 +27,10 @@
   "license": "MIT",
   "main": "./lib/index.cjs",
   "bin": {
-    "nwbuild": "./bin/nwbuild.cjs"
+    "nwbuild": "./lib/cli.cjs"
   },
   "type": "module",
   "files": [
-    "bin",
     "lib",
     "src"
   ],
@@ -42,51 +41,41 @@
   },
   "scripts": {
     "postinstall": "npm run test:prep",
-    "fmt": "prettier --write .",
-    "lnt": "eslint --config=cfg/eslint.config.cjs --fix src",
+    "lint": "eslint src test",
+    "lint:fix": "eslint --fix src test",
     "test:prep": "esbuild src/index.js --bundle --platform=node --outfile=./dist/index.cjs",
-    "test:jest": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
+    "test:unit": "node --test test/unit/detectCurrentPlatform.js ",
     "test:tape": "tape './test/*.cjs'",
     "test:sanity": "node --test-reporter=spec --test e2e/test.js",
-    "demo": "npm run test:prep && npm link nw-builder && cd test && node demo.cjs"
+    "demo": "cd test && node demo.cjs"
   },
   "devDependencies": {
     "decompress-zip": "^0.3.3",
-    "eslint": "^8.47.0",
-    "eslint-config-tjw-jsdoc": "^1.0.3",
-    "jest": "^29.6.2",
-    "jest-environment-jsdom": "^29.6.2",
-    "jsdom": "^22.1.0",
-    "nock": "^13.3.3",
-    "prettier": "^3.0.2",
+    "eslint": "^9.3.0",
+    "nock": "^13.5.4",
     "redtape": "^1.0.0",
-    "rimraf": "^3.0.2",
-    "selenium-webdriver": "^4.11.1",
-    "tape": "^5.6.6"
+    "rimraf": "^5.0.7",
+    "selenium-webdriver": "^4.21.0",
+    "tape": "^5.7.5",
+    "vitest": "^1.6.0"
   },
   "dependencies": {
-    "archiver": "^6.0.0",
+    "archiver": "^7.0.1",
     "cli-progress": "^3.12.0",
-    "compressing": "^1.9.1",
-    "esbuild": "^0.19.2",
+    "compressing": "^1.10.1",
+    "esbuild": "^0.21.3",
     "graceful-fs-extra": "^2.0.0",
     "lodash": "^4.17.21",
     "plist": "^3.1.0",
-    "rcedit": "^3.0.1",
+    "rcedit": "^4.0.1",
     "request": "^2.88.2",
-    "semver": "^7.5.4",
+    "semver": "^7.6.2",
     "simple-glob": "^0.2.0",
     "temp": "^0.9.4",
     "thenify": "^3.3.1",
     "winresourcer": "^0.9.0",
-    "winston": "^3.10.0",
+    "winston": "^3.13.0",
     "yargs": "^17.7.2"
   },
-  "engines": {
-    "node": "v20.5.1"
-  },
-  "packageManager": "npm@9.8.1",
-  "jest": {
-    "testEnvironment": "jsdom"
-  }
+  "packageManager": "npm@10.5.2"
 }

package/src/index.js

@@ -1,7 +1,6 @@
 import Options from "./constants/Options";
 import Platform from "./constants/Platform";
 import Platforms from "./constants/Platforms";
-import checkCache from "./utilities/checkCache";
 import detectCurrentPlatform from "./utilities/detectCurrentPlatform";
 
 import { get } from "./get.js";
@@ -14,7 +13,6 @@ export {
   Platform,
   Platforms,
   detectCurrentPlatform,
-  checkCache,
   get,
   getReleaseInfo,
   isCached,

package/src/log.js

@@ -7,7 +7,7 @@ const customFormat = printf(({ level, message }) => {
 });
 
 export let log = createLogger({
-  format: combine(errors({stack: true}), timestamp(), customFormat),
+  format: combine(errors({ stack: true }), timestamp(), customFormat),
   transports: [
     new transports.Console({
       level: "info",

package/src/utilities/detectCurrentPlatform.js

@@ -10,9 +10,7 @@ const detectCurrentPlatform = (process) => {
       return process.arch === "x64" ? Platform.OSX_64 : Platform.OSX_32;
 
     case "win32":
-      return process.arch === "x64" || process.env.PROCESSOR_ARCHITEW6432
-        ? Platform.WIN_64
-        : Platform.WIN_32;
+      return process.arch === "x64" ? Platform.WIN_64 : Platform.WIN_32;
 
     case "linux":
       return process.arch === "x64" ? Platform.NIX_64 : Platform.NIX_32;

package/src/utilities/checkCache.js

@@ -1,30 +0,0 @@
-import fs from "fs";
-import path from "path";
-
-/**
- *
- * @param  {string}   filePath
- * @param  {string[]} files
- * @return {boolean}
- */
-const checkCache = (filePath, files) => {
-  let missing = false;
-
-  // If NW.js is above v0.12.3, then we don't know which files we want from the archives. So just check that the folder exists and has at least 3 files in it.
-  if (files.length === 1 && files[0] === "*") {
-    return fs.existsSync(filePath) && fs.readdirSync(filePath).length >= 2;
-  }
-
-  for (let file of files) {
-    if (missing) {
-      return false;
-    }
-    if (!fs.existsSync(path.join(filePath, file))) {
-      missing = true;
-    }
-  }
-
-  return !missing;
-};
-
-export default checkCache;