nw-builder 4.2.7 → 4.3.0

package/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nw-builder",
-  "version": "4.2.7",
+  "version": "4.3.0",
   "description": "Build NW.js desktop applications for MacOS, Windows and Linux.",
   "keywords": [
     "NW.js",
@@ -41,7 +41,7 @@
   "scripts": {
     "fmt": "prettier --write \"./**/*.{css,html,js,json,md,yml}\"",
     "lnt": "eslint --config=cfg/eslint.config.cjs --fix src",
-    "doc:api": "jsdoc2md ./src/index.js > ./doc/api.md && jsdoc2md ./src/bld/linuxCfg.js > ./doc/api-nux.md && jsdoc2md ./src/bld/winCfg.js > ./doc/api-win.md",
+    "doc:api": "jsdoc2md ./src/index.js > ./doc/api.md && jsdoc2md ./src/bld/linuxCfg.js > ./doc/api-nux.md && jsdoc2md ./src/bld/winCfg.js > ./doc/api-win.md && jsdoc2md ./src/bld/osxCfg.js > ./doc/api-osx.md",
     "doc:dev": "vitepress dev doc",
     "doc:bld": "vitepress build doc",
     "test:unit": "node --test-reporter=spec --test test/unit/index.js",
@@ -49,24 +49,23 @@
     "test:demo": "cd test/fixture && node demo.js"
   },
   "devDependencies": {
-    "eslint": "^8.42.0",
+    "eslint": "^8.44.0",
     "eslint-config-tjw-jsdoc": "^1.0.3",
     "gh-pages": "^5.0.0",
     "jsdoc": "^4.0.2",
     "jsdoc-to-markdown": "^8.0.0",
-    "prettier": "^2.8.6",
+    "prettier": "^2.8.8",
     "selenium-webdriver": "^4.10.0",
-    "vitepress": "^1.0.0-beta.2"
+    "vitepress": "^1.0.0-beta.4"
   },
   "dependencies": {
-    "archiver": "^5.3.1",
     "cli-progress": "^3.12.0",
     "compressing": "^1.9.0",
-    "glob": "^10.2.7",
+    "glob": "^10.3.1",
     "plist": "^3.0.6",
     "rcedit": "^3.0.1",
-    "winston": "^3.8.2",
-    "yargs": "^17.7.1"
+    "winston": "^3.9.0",
+    "yargs": "^17.7.2"
   },
   "bin": {
     "nwbuild": "./src/cli.js"

package/src/bld/build.js

@@ -1,9 +1,10 @@
 import { resolve } from "node:path";
 import { cp, rm, writeFile } from "node:fs/promises";
 
+import compressing from "compressing";
+
 import { log } from "../log.js";
 
-import { compress } from "./compress.js";
 import { setLinuxConfig } from "./linuxCfg.js";
 import { setOsxConfig } from "./osxCfg.js";
 import { setWinConfig } from "./winCfg.js";
@@ -92,9 +93,15 @@ export const build = async (
       break;
   }
 
-  if (zip === true) {
-    await compress(outDir);
-  } else if (zip === "zip") {
-    await compress(outDir, zip);
+  if (zip !== false) {
+    if (zip === true || zip === "zip") {
+      await compressing.zip.compressDir(outDir, `${outDir}.zip`);
+    } else if (zip === "tar") {
+      await compressing.tar.compressDir(outDir, `${outDir}.tar`);
+    } else if (zip === "tgz") {
+      await compressing.tgz.compressDir(outDir, `${outDir}.tgz`);
+    }
+
+    await rm(outDir, { recursive: true, force: true });
   }
 };

package/src/bld/linuxCfg.js

@@ -5,6 +5,7 @@ import { log } from "../log.js";
 
 /**
  * @typedef  {object}   LinuxRc               Linux configuration options
+ * @typedef  {string}   name                  Name of the application
  * @property {string}   genericName           Generic name of the application
  * @property {boolean}  noDisplay             If true the application is not displayed
  * @property {string}   comment               Tooltip for the entry, for example "View sites on the Internet".

package/src/bld/osxCfg.js

@@ -1,13 +1,27 @@
 import { platform } from "node:process";
 import fs from "node:fs/promises";
-import path from "node:path";
+import { resolve } from "node:path";
 
 import plist from "plist";
 
 import { log } from "../log.js";
 
+/**
+ * @typedef {object}  OsxRc                      OSX resource configuration options
+ * @property {string} name                        The name of the application
+ * @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.
+ * @property {string} CFBundleDisplayName         The user-visible name for the bundle.
+ * @property {string} CFBundleSpokenName          A replacement for the app name in text-to-speech operations.
+ * @property {string} CFBundleVersion             The version of the build that identifies an iteration of the bundle.
+ * @property {string} CFBundleShortVersionString  The release or version number of the bundle.
+ * @property {string} NSHumanReadableCopyright    A human-readable copyright notice for the bundle.
+ */
+
 /**
  * OSX specific configuration steps
+ * https://developer.apple.com/documentation/bundleresources/information_property_list
  *
  * @param  {object}             app     Resource configuration options for MacOS
  * @param  {string}             outDir  The directory to hold build artifacts
@@ -20,37 +34,31 @@ const setOsxConfig = async (app, outDir) => {
     );
   }
   try {
-    const outApp = path.resolve(outDir, `${app.name}.app`);
-    await fs.rename(path.resolve(outDir, "nwjs.app"), outApp);
+    const outApp = resolve(outDir, `${app.name}.app`);
+    await fs.rename(resolve(outDir, "nwjs.app"), outApp);
 
-    // Rename CFBundleDisplayName in Contents/Info.plist
-    const contentsInfoPlistPath = path.resolve(outApp, "Contents/Info.plist");
-    const contentsInfoPlistJson = plist.parse(
-      await fs.readFile(contentsInfoPlistPath, "utf-8")
-    );
-    contentsInfoPlistJson.CFBundleDisplayName = app.name;
-    const contentsInfoPlist = plist.build(contentsInfoPlistJson);
-    await fs.writeFile(contentsInfoPlistPath, contentsInfoPlist);
-
-    // Rename CFBundleDisplayName in Contents/Resources/en.lproj/InfoPlist.strings
-    const contentsInfoPlistStringsPath = path.resolve(
-      outApp,
-      "Contents/Resources/en.lproj/InfoPlist.strings"
+    const infoPlistPath = resolve(outApp, "Contents/Info.plist");
+    const infoPlistJson = plist.parse(
+      await fs.readFile(infoPlistPath, "utf-8")
     );
-    const contentsInfoPlistStrings = await fs.readFile(
-      contentsInfoPlistStringsPath,
-      "utf-8"
-    );
-    const newPlistStrings = contentsInfoPlistStrings.replace(
-      /CFBundleGetInfoString = "nwjs /,
-      `CFBundleGetInfoString = "${app.name} `
-    );
-    await fs.writeFile(contentsInfoPlistStringsPath, newPlistStrings);
 
-    // Add product_string property to package.json
-    // const packageJsonPath = path.resolve(outApp, "Contents/Resources/app.nw/package.json");
-    // app.product_string = app.name;
-    // await fs.writeFile(packageJsonPath, JSON.stringify(app, null, 4));
+    infoPlistJson.LSApplicationCategoryType = app.LSApplicationCategoryType;
+    infoPlistJson.CFBundleIdentifier = app.CFBundleIdentifier;
+    infoPlistJson.CFBundleName = app.CFBundleName;
+    infoPlistJson.CFBundleDisplayName = app.CFBundleDisplayName;
+    infoPlistJson.CFBundleSpokenName = app.CFBundleSpokenName;
+    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) {
+        delete infoPlistJson[option];
+      }
+    });
+
+    await fs.writeFile(infoPlistPath, plist.build(infoPlistJson));
   } catch (error) {
     log.error(error);
   }

package/src/bld/winCfg.js

@@ -7,6 +7,8 @@ import { log } from "../log.js";
 
 /**
  * @typedef {object} WinRc              Windows configuration options
+ * @property {string} name              The name of the application
+ * @property {string} version           The version of the application
  * @property {string} comments          Additional information that should be displayed for diagnostic purposes.
  * @property {string} company           Company that produced the file—for example, Microsoft Corporation or Standard Microsystems Corporation, Inc. This string is required.
  * @property {string} fileDescription   File description to be presented to users. This string may be displayed in a list box when the user is choosing files to install. For example, Keyboard Driver for AT-Style Keyboards. This string is required.
@@ -58,7 +60,6 @@ const setWinConfig = async (app, outDir) => {
     await rename(resolve(outDir, "nw.exe"), outDirAppExe);
     await rcedit(outDirAppExe, {
       "file-version": app.version,
-      icon: app.icon,
       "product-version": app.version,
       "version-string": versionString,
     });

package/src/get/remove.js

@@ -15,15 +15,18 @@ const remove = async (platform, cacheDir, downloadUrl) => {
   try {
     if (downloadUrl === "https://dl.nwjs.io/") {
       if (platform === "linux") {
-        await rm(resolve(cacheDir, "nw.tgz"));
+        await rm(resolve(cacheDir, "nw.tgz"), { recursive: true, force: true });
       } else {
-        await rm(resolve(cacheDir, "nw.zip"));
+        await rm(resolve(cacheDir, "nw.zip"), { recursive: true, force: true });
       }
     } else if (
       downloadUrl ===
       "https://github.com/nwjs-ffmpeg-prebuilt/nwjs-ffmpeg-prebuilt/releases/download"
     ) {
-      await rm(resolve(cacheDir, "ffmpeg.zip"));
+      await rm(resolve(cacheDir, "ffmpeg.zip"), {
+        recursive: true,
+        force: true,
+      });
     }
   } catch (error) {
     log.error(error);

package/src/index.d.ts

@@ -15,6 +15,7 @@ type Options = {
     cli: boolean,
     ffmpeg: boolean,
     glob: boolean,
+    logLevel: "error" | "warn" | "info" | "debug"
 };
 
 declare function nwbuild(options: Options): Promise<unknown>;

package/src/index.js

@@ -1,5 +1,6 @@
 import { mkdir, rm } from "node:fs/promises";
 import { resolve } from "node:path";
+import { arch, platform, version } from "node:process";
 
 import { decompress } from "./get/decompress.js";
 import { download } from "./get/download.js";
@@ -15,7 +16,7 @@ import { parse } from "./util/parse.js";
 import { validate } from "./util/validate.js";
 import { xattr } from "./util/xattr.js";
 
-import { log } from "./log.js";
+import { log, setLogLevel } from "./log.js";
 
 /**
  * @typedef {object} Options Configuration options
@@ -31,10 +32,11 @@ import { log } from "./log.js";
  * @property {"https://nwjs.io/versions" | string} [manifestUrl="https://nwjs.io/versions"]  URI to download manifest from
  * @property {object}                              app                                       Refer to Linux/Windows Specific Options under Getting Started in the docs
  * @property {boolean}                             [cache=true]                              If true the existing cache is used. Otherwise it removes and redownloads it.
- * @property {boolean}                             [zip=false]                               If true the outDir directory is zipped
+ * @property {boolean | "zip" | "tar" | "tgz"}     [zip=false]                               If true, "zip", "tar" or "tgz" the outDir directory is compressed.
  * @property {boolean}                             [cli=false]                               If true the CLI is used to glob srcDir and parse other options
  * @property {boolean}                             [ffmpeg=false]                            If true the chromium ffmpeg is replaced by community version
  * @property {boolean}                             [glob=true]                               If true globbing is enabled
+ * @property {"error" | "warn" | "info" | "debug"} [logLevel="info"]                         Specified log level.
  */
 
 /**
@@ -92,9 +94,18 @@ const nwbuild = async (options) => {
 
     await validate(options, releaseInfo);
 
+    setLogLevel(options.logLevel);
+
     // Remove leading "v" from version string
     options.version = releaseInfo.version.slice(1);
 
+    if (options.logLevel === "debug") {
+      log.debug(`Platform: ${platform}`);
+      log.debug(`Archicture: ${arch}`);
+      log.debug(`Node Version: ${version}`);
+      log.debug(`NW.js Version: ${options.version}\n`);
+    }
+
     // Variable to store nwDir file path
     nwDir = resolve(
       options.cacheDir,

package/src/log.js

@@ -2,11 +2,11 @@ import { createLogger, format, transports } from "winston";
 
 const { combine, timestamp, printf } = format;
 
-const customFormat = printf(({ level, message, timestamp }) => {
-  return `[ ${level.toUpperCase()} ] ${timestamp} ${message}`;
+const customFormat = printf(({ level, message }) => {
+  return `[ ${level.toUpperCase()} ] ${message}`;
 });
 
-export const log = createLogger({
+export let log = createLogger({
   format: combine(timestamp(), customFormat),
   transports: [
     new transports.Console({
@@ -15,10 +15,18 @@ export const log = createLogger({
   ],
 });
 
-// if (process.env.NODE_ENV !== "production") {
-//   log.add(
-//     new transports.Console({
-//       level: "debug",
-//     }),
-//   );
-// }
+/**
+ * Sets the log level
+ *
+ * @param {import("./index.js").Options.logLevel} level  Log level
+ */
+export function setLogLevel(level) {
+  log = createLogger({
+    format: combine(timestamp(), customFormat),
+    transports: [
+      new transports.Console({
+        level: level,
+      }),
+    ],
+  });
+}

package/src/util/parse.js

@@ -24,6 +24,7 @@ export const parse = async (options, pkg) => {
   options.cacheDir = options.cacheDir ?? "./cache";
   options.cache = options.cache ?? true;
   options.ffmpeg = options.ffmpeg ?? false;
+  options.logLevel = options.logLevel ?? "info";
 
   if (options.mode === "get") {
     return { ...options };
@@ -43,10 +44,9 @@ export const parse = async (options, pkg) => {
   options.app = options.app ?? {};
   options.app.name = options.app.name ?? pkg.name;
 
-  // TODO: move this out to
+  // TODO(#737): move this out
   if (options.platform === "linux") {
     // linux desktop entry file configurations options
-    options.app.name = options.app.name ?? pkg.name;
     options.app.genericName = options.app.genericName ?? undefined;
     options.app.noDisplay = options.app.noDisplay ?? undefined;
     options.app.comment = options.app.comment ?? undefined;
@@ -72,6 +72,7 @@ export const parse = async (options, pkg) => {
   }
   if (options.platform === "win") {
     // windows configuration options
+    options.app.version = options.app.version ?? pkg.version;
     options.app.comments = options.app.comments ?? undefined;
     options.app.company = options.app.company ?? pkg.author;
     options.app.fileDescription =
@@ -87,5 +88,22 @@ export const parse = async (options, pkg) => {
     options.app.specialBuild = options.app.specialBuild ?? undefined;
   }
 
+  if (options.platform === "osx") {
+    options.app.LSApplicationCategoryType =
+      options.app.LSApplicationCategoryType ?? undefined;
+    options.app.CFBundleIdentifier =
+      options.app.CFBundleIdentifier ?? options.app.name;
+    options.app.CFBundleName = options.app.CFBundleName ?? pkg.name;
+    options.app.CFBundleDisplayName =
+      options.app.CFBundleDisplayName ?? pkg.name;
+    options.app.CFBundleSpokenName = options.app.CFBundleSpokenName ?? pkg.name;
+    options.app.CFBundleShortVersionString =
+      options.app.CFBundleVersion ?? pkg.version;
+    options.app.CFBundleVersion =
+      options.app.CFBundleShortVersionString ?? pkg.version;
+    options.app.NSHumanReadableCopyright =
+      options.app.NSHumanReadableCopyright ?? undefined;
+  }
+
   return { ...options };
 };

package/src/util/validate.js

@@ -3,9 +3,9 @@ import { readdir } from "node:fs/promises";
 /**
  * Validate options
  *
- * @param  {import("../../index.js").OPTIONS} options      Options
- * @param  {object}                           releaseInfo  Version specific NW release info
- * @return {Promise<undefined>}                            Return undefined if options are valid
+ * @param  {import("../index.js").Options} options      Options
+ * @param  {object}                        releaseInfo  Version specific NW release info
+ * @return {Promise<undefined>}                         Return undefined if options are valid
  * @throws {Error}                                         Throw error if options are invalid
  */
 export const validate = async (options, releaseInfo) => {
@@ -47,6 +47,17 @@ export const validate = async (options, releaseInfo) => {
     );
   }
 
+  if (
+    options.logLevel !== "error" &&
+    options.logLevel !== "warn" &&
+    options.logLevel !== "info" &&
+    options.logLevel !== "debug"
+  ) {
+    throw new Error(
+      "Expected 'error', 'warn', 'info' or 'debug'. Got " + options.logLevel
+    );
+  }
+
   if (options.mode === "get") {
     return undefined;
   }

package/src/bld/compress.js

@@ -1,40 +0,0 @@
-import fs from "node:fs";
-import archiver from "archiver";
-
-import { log } from "../log.js";
-
-/**
- * Compress a out directory
- *
- * @param  {string}             outDir  - Output directory
- * @param  {string}             type    - Compression type
- * @return {Promise<undefined>}
- */
-const compress = (outDir, type = "zip") => {
-  const output = fs.createWriteStream(`${outDir}.${type}`);
-  const archive = archiver("zip");
-
-  return new Promise((res, rej) => {
-    output.on("close", () => {
-      res();
-    });
-
-    archive.on("warning", (err) => {
-      if (err.code === "ENOENT") {
-        log.debug(err);
-      } else {
-        rej(err);
-      }
-    });
-
-    archive.on("error", (err) => {
-      rej(err);
-    });
-
-    archive.pipe(output);
-    archive.directory(outDir, false);
-    archive.finalize();
-  });
-};
-
-export { compress };