nw-builder 4.0.7 → 4.0.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nw-builder",
-  "version": "4.0.7",
+  "version": "4.0.8",
   "description": "Build NW.js desktop applications for MacOS, Windows and Linux.",
   "keywords": [
     "NW.js",

package/src/get/getReleaseInfo.js

@@ -34,8 +34,6 @@ export const getReleaseInfo = async (version, cacheDir, manifestUrl) => {
     releaseData = manifest.versions.find(
       (release) => release.version === `v${version}`,
     );
-
-    releaseData.version = version;
   }
   return releaseData;
 };

package/src/nwbuild.js

@@ -1,7 +1,4 @@
-import { mkdir, readFile, rm } from "node:fs/promises";
-import { basename } from "node:path";
-
-import glob from "glob-promise";
+import { mkdir, rm } from "node:fs/promises";
 
 import { decompress } from "./get/decompress.js";
 import { download } from "./get/download.js";
@@ -11,6 +8,7 @@ import { packager } from "./bld/package.js";
 import { develop } from "./run/develop.js";
 import { isCached } from "./util/cache.js";
 import { notify } from "./util/notify.js";
+import { getOptions } from "./util/options.js";
 import { parse } from "./util/parse.js";
 import { validate } from "./util/validate.js";
 
@@ -81,93 +79,56 @@ import { log } from "./log.js";
  */
 const nwbuild = async (options) => {
   let nwDir = "";
-  let nwPkg = undefined;
   let cached;
+  let nwCached;
   let built;
   let releaseInfo = {};
+
   notify();
-  try {
-    let files = [];
-    let patterns = options.srcDir.split(" ");
-
-    for (const pattern of patterns) {
-      let contents = await glob(pattern);
-      files.push(...contents);
-      // Try to find the first instance of the package.json
-      for (const content of contents) {
-        if (basename(content) === "package.json" && nwPkg === undefined) {
-          nwPkg = JSON.parse(await readFile(content));
-        }
-      }
-
-      if (nwPkg === undefined) {
-        throw new Error("package.json not found in srcDir file glob patterns.");
-      }
-    }
 
-    if (files.length === 0) {
-      throw new Error(`The globbing pattern ${options.srcDir} is invalid.`);
-    }
+  try {
+    const { opts, files, nwPkg } = await getOptions(options);
+    options = opts;
 
-    // The name property is required for NW.js applications
-    if (nwPkg.name === undefined) {
-      throw new Error(`name property is missing from package.json`);
-    }
+    // Parse options
+    options = await parse(options, nwPkg);
 
-    // The main property is required for NW.js applications
-    if (nwPkg.main === undefined) {
-      throw new Error(`main property is missing from package.json`);
+    // Create cacheDir if it does not exist
+    cached = await isCached(options.cacheDir);
+    if (cached === false) {
+      await mkdir(options.cacheDir, { recursive: true });
     }
 
-    // If the nwbuild property exists in srcDir/package.json, then they take precedence
-    if (typeof nwPkg.nwbuild === "object") {
-      options = { ...nwPkg.nwbuild };
-    } else if (typeof nwPkg.nwbuild === "undefined") {
-      log.debug(`nwbuild property is not defined in package.json`);
-    } else {
-      throw new Error(
-        `nwbuild property in the package.json is of type ${typeof nwPkg.nwbuild}. Expected type object.`,
-      );
+    // Create outDir if it does not exist
+    built = await isCached(options.outDir);
+    if (built === false) {
+      await mkdir(options.outDir, { recursive: true });
     }
 
-    // Parse options, set required values to undefined and flags with default values unless specified by user
-    options = await parse(options, nwPkg);
-
-    // Validate options.version here
-    // We need to do this to get the version specific release info
+    // Validate options.version to get the version specific release info
     releaseInfo = await getReleaseInfo(
       options.version,
       options.cacheDir,
       options.manifestUrl,
     );
-    options.version = releaseInfo.version;
+    // Remove leading "v" from version string
+    options.version = releaseInfo.version.slice(1);
 
-    validate(options, releaseInfo);
+    await validate(options, releaseInfo);
 
     // Variable to store nwDir file path
     nwDir = `${options.cacheDir}/nwjs${
       options.flavor === "sdk" ? "-sdk" : ""
     }-v${options.version}-${options.platform}-${options.arch}`;
 
-    // Create cacheDir if it does not exist
-    cached = await isCached(nwDir);
-    if (cached === false) {
-      await mkdir(nwDir, { recursive: true });
-    }
-
-    // Create outDir if it does not exist
-    built = await isCached(options.outDir);
-    if (built === false) {
-      await mkdir(options.outDir, { recursive: true });
-    }
-
+    nwCached = await isCached(nwDir);
     // Remove cached NW binary
-    if (options.cache === false && cached === true) {
+    if (options.cache === false && nwCached === true) {
       log.debug("Remove cached NW binary");
       await rm(nwDir, { force: true, recursive: true });
     }
     // Download relevant NW.js binaries
-    if (cached === false) {
+    if (nwCached === false) {
       log.debug("Download relevant NW.js binaries");
       await download(
         options.version,

package/src/util/cache.js

@@ -3,8 +3,8 @@ import { access, constants } from "node:fs/promises";
 /**
  * Check if NW binaries are cached
  *
- * @param  {string}           nwDir  Path to cached NW binaries
- * @return {Promise<boolean>}        Boolean value to denote if cache exists or not
+ * @param  {string}  nwDir  Path to cached NW binaries
+ * @return {boolean}        Boolean value to denote if cache exists or not
  */
 export const isCached = async (nwDir) => {
   let exists = true;

package/src/util/notify.js

@@ -1,14 +1,13 @@
-import { createRequire } from 'node:module';
+import { createRequire } from "node:module";
 const require = createRequire(import.meta.url);
 
 import updateNotifier from "update-notifier";
 
-
 /**
  * Notify the user if there is a new version of the package available.
-*
-* @return {Promise<void>}
-*/
+ *
+ * @return {Promise<void>}
+ */
 export const notify = async () => {
   const packageJson = require("../../package.json");
   updateNotifier({ pkg: packageJson }).notify();

package/src/util/options.js

@@ -0,0 +1,50 @@
+import { readFile } from "node:fs/promises";
+import { basename } from "node:path";
+
+import glob from "glob-promise";
+
+import { log } from "../log.js";
+
+/**
+ * Get options object from package.json, otherwise from module/cli
+ *
+ * @param  {import("../nwbuild").Options} opts  The options object
+ * @return {Promise<object>}                    The options object
+ */
+export const getOptions = async (opts) => {
+  let files = [];
+  let nwPkg;
+  const patterns = opts.srcDir.split(" ");
+
+  for (const pattern of patterns) {
+    let contents = await glob(pattern);
+    files.push(...contents);
+    // Try to find the first instance of the package.json
+    for (const content of contents) {
+      if (basename(content) === "package.json" && nwPkg === undefined) {
+        nwPkg = JSON.parse(await readFile(content));
+      }
+    }
+
+    if (nwPkg === undefined) {
+      throw new Error("package.json not found in srcDir file glob patterns.");
+    }
+  }
+
+  if (files.length === 0) {
+    throw new Error(`The globbing pattern ${opts.srcDir} is invalid.`);
+  }
+
+  // If the nwbuild property exists in srcDir/package.json, then they take precedence
+  if (typeof nwPkg.nwbuild === "object") {
+    opts = { ...nwPkg.nwbuild };
+  } else if (typeof nwPkg.nwbuild === "undefined") {
+    log.debug(`nwbuild property is not defined in package.json`);
+  } else {
+    throw new Error(
+      `nwbuild property in the package.json is of type ${typeof nwPkg.nwbuild}. Expected type object.`,
+    );
+  }
+
+  return { opts, files, nwPkg };
+};

package/src/util/validate.js

@@ -3,9 +3,9 @@ import { readdir } from "node:fs/promises";
 /**
  * Validate options
  *
- * @param  {object}    options      Options
- * @param  {object}    releaseInfo  Version specific NW release info
- * @return {undefined}              True if options are valid. False otherwise
+ * @param  {object}             options      Options
+ * @param  {object}             releaseInfo  Version specific NW release info
+ * @return {Promise<undefined>}              True if options are valid. False otherwise
  */
 export const validate = async (options, releaseInfo) => {
   if (options.srcDir === "") {