nw-builder 4.0.2 → 4.0.4

package/src/bld/winCfg.js

@@ -2,27 +2,55 @@ import { rename } from "node:fs/promises";
 
 import rcedit from "rcedit";
 
+import { log } from "../log.js";
+
 /**
  * Windows specific configuration steps
+ * https://learn.microsoft.com/en-us/windows/win32/msi/version
+ * https://learn.microsoft.com/en-gb/windows/win32/sbscs/application-manifests
+ * https://learn.microsoft.com/en-us/previous-versions/visualstudio/visual-studio-2015/deployment/trustinfo-element-clickonce-application?view=vs-2015#requestedexecutionlevel
+ * https://learn.microsoft.com/en-gb/windows/win32/menurc/versioninfo-resource
  *
- * @param {object} pkg     The srcDir/package.json as a JSON
+ * @param {object} app     Multi platform configuration options
  * @param {string} outDir  The directory to hold build artifacts
  */
-const setWinConfig = async (pkg, outDir) => {
-  await rename(`${outDir}/nw.exe`, `${outDir}/${pkg.name}.exe`);
+const setWinConfig = async (app, outDir) => {
+  let versionString = {
+    Comments: app.comments,
+    CompanyName: app.author,
+    FileDescription: app.fileDescription,
+    FileVersion: app.fileVersion,
+    InternalName: app.name,
+    LegalCopyright: app.legalCopyright,
+    LegalTrademarks: app.legalTrademark,
+    OriginalFilename: app.name,
+    PrivateBuild: app.name,
+    ProductName: app.name,
+    ProductVersion: app.version,
+    SpecialBuild: app.name,
+  };
 
-  // https://learn.microsoft.com/en-gb/windows/win32/menurc/versioninfo-resource?redirectedfrom=MSDN#string-name
-  await rcedit(`${outDir}/${pkg.name}.exe`, {
-    "file-version": pkg.version,
-    "product-version": pkg.version,
-    "icon": pkg.icon,
-    "version-string": {
-      FileDescription: pkg.description,
-      LegalCopyright: pkg.copyright,
-      ProductName: pkg.name,
-      OriginalFilename: pkg.name,
-    },
+  Object.keys(versionString).forEach((option) => {
+    if (versionString[option] === undefined) {
+      delete versionString[option];
+    }
   });
+
+  try {
+    await rename(`${outDir}/nw.exe`, `${outDir}/${app.name}.exe`);
+
+    await rcedit(`${outDir}/${app.name}.exe`, {
+      "file-version": app.version,
+      "icon": app.icon,
+      "product-version": app.version,
+      "version-string": versionString,
+    });
+  } catch (error) {
+    log.warn(
+      "Unable to modify EXE. Ensure WINE is installed or build in Windows",
+    );
+    log.error(error);
+  }
 };
 
 export { setWinConfig };

package/src/cli.js

@@ -3,18 +3,22 @@
 import yargs from "yargs/yargs";
 import { hideBin } from "yargs/helpers";
 
-import { nwbuild } from "./nwbuild.js";
+import nwbuild from "./nwbuild.js";
 
 const cli = yargs(hideBin(process.argv))
   .version(false)
   .command("[srcDir] [options]")
+  .option("mode", {
+    type: "string",
+    description: "`run` or `build` application",
+  })
   .option("version", {
     type: "string",
     description: "NW.js version",
   })
-  .option("flavour", {
+  .option("flavor", {
     type: "string",
-    description: "NW.js build flavour",
+    description: "NW.js build flavor",
   })
   .option("platform", {
     type: "string",
@@ -28,10 +32,9 @@ const cli = yargs(hideBin(process.argv))
     type: "string",
     description: "NW.js build artifacts",
   })
-  .demandOption(["version", "flavour", "platform", "arch", "outDir"])
   .parse();
 
 nwbuild({
   ...cli,
-  srcDir: cli._[0],
-});
+  srcDir: cli._.join(" "),
+});

package/src/get/download.js

@@ -7,7 +7,7 @@ const bar = new progress.SingleBar({}, progress.Presets.rect);
 
 const download = (
   version,
-  flavour,
+  flavor,
   platform,
   architecture,
   downloadUrl,
@@ -15,12 +15,11 @@ const download = (
 ) => {
   return new Promise((resolve, reject) => {
     if (downloadUrl !== "https://dl.nwjs.io") {
-      console.log("Invalid download url. Please try again.");
-      reject(1);
+      reject(new Error("Invalid download url. Please try again."));
     }
 
     let url = `${downloadUrl}/v${version}/nwjs${
-      flavour === "sdk" ? "-sdk" : ""
+      flavor === "sdk" ? "-sdk" : ""
     }-v${version}-${platform}-${architecture}.${
       platform === "linux" ? "tar.gz" : "zip"
     }`;
@@ -36,13 +35,12 @@ const download = (
       });
 
       res.on("error", (error) => {
-        console.log(error);
-        reject(1);
+        reject(error);
       });
 
       res.on("end", () => {
         bar.stop();
-        resolve(0);
+        resolve();
       });
 
       fs.mkdirSync(outDir, { recursive: true });

package/src/get/getReleaseInfo.js

@@ -28,6 +28,10 @@ export const getReleaseInfo = async (version, cacheDir, manifestUrl) => {
     log.debug("Convert manifest data into JSON");
     let manifestJson = JSON.parse(manifestData);
     log.debug(`Search for ${version} specific release data`);
+    if (version === "latest" || version === "stable" || version === "lts") {
+      version = manifestData[version].slice(1);
+    }
+
     releaseData = manifestJson.versions.find(
       (release) => release.version === `v${version}`,
     );

package/src/nwbuild.js

@@ -1,96 +1,197 @@
-import { access, constants, readFile, rm } from "node:fs/promises";
-import { cwd } from "node:process";
+import { mkdir, readFile, rm } from "node:fs/promises";
+import { basename } from "node:path";
+
+import glob from "glob-promise";
 
 import { decompress } from "./get/decompress.js";
-import { develop } from "./run/develop.js";
 import { download } from "./get/download.js";
 import { getReleaseInfo } from "./get/getReleaseInfo.js";
 import { remove } from "./get/remove.js";
 import { packager } from "./bld/package.js";
+import { develop } from "./run/develop.js";
+import { isCached } from "./util/cache.js";
+import { parse } from "./util/parse.js";
+import { validate } from "./util/validate.js";
+
+import { log } from "./log.js";
 
 /**
- * Options schema
- *
- * @typedef {Object} OptionsSchema
- * @property {string}                  srcDir
- * @property {string}                  cacheDir
- * @property {string}                  version
- * @property {"sdk" | "normal"}        flavour
- * @property {"linux" | "osx" | "win"} platform
- * @property {"ia32" | "x64"}          arch
- * @property {string}                  outDir
+ * @typedef {object} App
+ * @property {string}   name                  Name of the application
+ *                                            Linux configuration options
+ * @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".
+ * @property {string}   icon                  Icon to display in file manager, menus, etc.
+ * @property {boolean}  hidden                TBD
+ * @property {string[]} onlyShowIn            A list of strings identifying the desktop environments that should (/not) display a given desktop entry
+ * @property {string[]} notShowIn             A list of strings identifying the desktop environments that should (/not) display a given desktop entry
+ * @property {boolean}  dBusActivatable       A boolean value specifying if D-Bus activation is supported for this application
+ * @property {string}   tryExec               Path to an executable file on disk used to determine if the program is actually installed
+ * @property {string}   exec                  Program to execute, possibly with arguments.
+ * @property {string}   path                  If entry is of type Application, the working directory to run the program in.
+ * @property {boolean}  terminal              Whether the program runs in a terminal window.
+ * @property {string[]} actions               Identifiers for application actions.
+ * @property {string[]} mimeType              The MIME type(s) supported by this application.
+ * @property {string[]} categories            Categories in which the entry should be shown in a menu
+ * @property {string[]} implements            A list of interfaces that this application implements.
+ * @property {string[]} keywords              A list of strings which may be used in addition to other metadata to describe this entry.
+ * @property {boolean}  startupNotify         If true, it is KNOWN that the application will send a "remove" message when started with the DESKTOP_STARTUP_ID environment variable set. If false, it is KNOWN that the application does not work with startup notification at all.
+ * @property {string}   startupWMClass        If specified, it is known that the application will map at least one window with the given string as its WM class or WM name hin
+ * @property {boolean}  prefersNonDefaultGPU  If true, the application prefers to be run on a more powerful discrete GPU if available.
+ * @property {string}   singleMainWindow      If true, the application has a single main window, and does not support having an additional one opened.
+ *                                            Windows configuration options
+ * @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.
+ * @property {string}   fileVersion           Version number of the file. For example, 3.10 or 5.00.RC2. This string is required.
+ * @property {string}   internalName          Internal name of the file, if one exists—for example, a module name if the file is a dynamic-link library. If the file has no internal name, this string should be the original filename, without extension. This string is required.
+ * @property {string}   legalCopyright        Copyright notices that apply to the file. This should include the full text of all notices, legal symbols, copyright dates, and so on. This string is optional.
+ * @property {string}   legalTrademark        Trademarks and registered trademarks that apply to the file. This should include the full text of all notices, legal symbols, trademark numbers, and so on. This string is optional.
+ * @property {string}   originalFilename      Original name of the file, not including a path. This information enables an application to determine whether a file has been renamed by a user. The format of the name depends on the file system for which the file was created. This string is required.
+ * @property {string}   privateBuild          Information about a private version of the file—for example, Built by TESTER1 on \\TESTBED. This string should be present only if VS_FF_PRIVATEBUILD is specified in the fileflags parameter of the root block.
+ * @property {string}   productName           Name of the product with which the file is distributed. This string is required.
+ * @property {string}   productVersion        Version of the product with which the file is distributed—for example, 3.10 or 5.00.RC2. This string is required.
+ * @property {string}   specialBuild          Text that specifies how this version of the file differs from the standard version—for example, Private build for TESTER1 solving mouse problems on M250 and M250E computers. This string should be present only if VS_FF_SPECIALBUILD is specified in the fileflags parameter of the root block.
  */
 
 /**
- *
- * @param  {OptionsSchema} obj
- * @return {void}
+ * @typedef {object} Options
+ * @property {string}                       srcDir       Directory to hold NW app files unless or array of file glob patterns
+ * @property {"run" | "build"}              mode         Run or build application
+ * @property {"latest" | "stable" | string} version      NW runtime version
+ * @property {"normal" | "sdk"}             flavor       NW runtime build flavor
+ * @property {"linux" | "osx" | "win"}      platform     NW supported platforms
+ * @property {"ia32" | "x64"}               arch         NW supported architectures
+ * @property {string}                       outDir       Directory to store build artifacts
+ * @property {"./cache" | string}           cacheDir     Directory to store NW binaries
+ * @property {"https://dl.nwjs.io"}         downloadUrl  URI to download NW binaries from
+ * @property {"https://nwjs.io/versions"}   manifestUrl  URI to download manifest from
+ * @property {App}                          app          Multi platform configuration options
+ * @property {boolean}                      cache        If true the existing cache is used. Otherwise it removes and redownloads it.
+ * @property {boolean}                      zip          If true the outDir directory is zipped
  */
-const nwbuild = async ({
-  srcDir,
-  cacheDir = `${cwd()}/cache`,
-  version,
-  flavour,
-  platform,
-  arch,
-  outDir,
-  // flags
-  downloadUrl = "https://dl.nwjs.io",
-  manifestUrl = "https://nwjs.io/versions",
-  noCache = false,
-  zip = false,
-  run = false,
-}) => {
-  let pkgPath = `${srcDir}/package.json`;
-  let pkgExist = true;
-  let pkgData = null;
 
+/**
+ * Entry point for nw-builder application
+ *
+ * @param  {...Options}         options  Options
+ * @return {Promise<undefined>}
+ */
+const nwbuild = async (options) => {
+  let nwDir = "";
+  let nwPkg = undefined;
+  let cached;
+  let built;
+  let releaseInfo = {};
   try {
-    await access(pkgPath, constants.F_OK);
-  } catch (e) {
-    pkgExist = false;
-  }
+    let files = [];
+    let patterns = options.srcDir.split(" ");
 
-  if (pkgExist === true) {
-    pkgData = await readFile(pkgPath, "utf8");
-    pkgData = JSON.parse(pkgData);
-    if (pkgData.nwbuild !== undefined) {
-      srcDir = pkgData.nwbuild.srcDir ?? srcDir;
-      cacheDir = pkgData.nwbuild.cacheDir ?? cacheDir;
-      version = pkgData.nwbuild.version ?? version;
-      flavour = pkgData.nwbuild.flavour ?? flavour;
-      platform = pkgData.nwbuild.platform ?? platform;
-      arch = pkgData.nwbuild.arch ?? arch;
-      outDir = pkgData.nwbuild.outDir ?? outDir;
+    for (const pattern of patterns) {
+      let contents = await glob(pattern);
+      for (const content of contents) {
+        if (basename(content) === "package.json" && nwPkg === undefined) {
+          nwPkg = JSON.parse(await readFile(content));
+        }
+        files.push(...contents);
+      }
     }
-  }
 
-  let nwDir = `${cacheDir}/nwjs${
-    flavour === "sdk" ? "-sdk" : ""
-  }-v${version}-${platform}-${arch}`;
+    if (files.length === 0) {
+      throw new Error(`The globbing pattern ${options.srcDir} is invalid.`);
+    }
 
-  let fileExists = true;
+    // The name property is required for NW.js applications
+    if (nwPkg.name === undefined) {
+      throw new Error(`name property is missing from package.json`);
+    }
 
-  try {
-    await access(nwDir, constants.F_OK);
-  } catch (e) {
-    fileExists = false;
-  }
+    // The main property is required for NW.js applications
+    if (nwPkg.main === undefined) {
+      throw new Error(`main property is missing from package.json`);
+    }
 
-  if (noCache === true || fileExists === false) {
-    await rm(nwDir, { force: true, recursive: true });
-    await download(version, flavour, platform, arch, downloadUrl, cacheDir);
-    await decompress(platform, cacheDir);
-    await remove(platform, cacheDir);
-  }
+    // If the nwbuild property exists in srcDir/package.json, then they take precedence
+    if (typeof nwPkg.nwbuild === "object") {
+      options = { ...nwPkg.nwbuild };
+    }
+    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.`,
+      );
+    }
+
+    // Parse options, set required values to undefined and flags with default values unless specified by user
+    options = await parse(options, nwPkg);
 
-  let releaseInfo = await getReleaseInfo(version, cacheDir, manifestUrl);
+    // 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 });
+    }
 
-  if (run === true) {
-    await develop(srcDir, nwDir, platform);
-  } else {
-    await packager(srcDir, nwDir, outDir, platform, zip, releaseInfo);
+    // Validate options.version here
+    // We need to do this to get the version specific release info
+    releaseInfo = await getReleaseInfo(
+      options.version,
+      options.cacheDir,
+      options.manifestUrl,
+    );
+
+    validate(options, releaseInfo);
+
+    // Remove cached NW binary
+    if (options.cache === false && cached === true) {
+      log.debug("Remove cached NW binary");
+      await rm(nwDir, { force: true, recursive: true });
+    }
+    // Download relevant NW.js binaries
+    if (cached === false) {
+      log.debug("Download relevant NW.js binaries");
+      await download(
+        options.version,
+        options.flavor,
+        options.platform,
+        options.arch,
+        options.downloadUrl,
+        options.cacheDir,
+      );
+      await decompress(options.platform, options.cacheDir);
+      await remove(options.platform, options.cacheDir);
+    }
+
+    if (options.mode === "run") {
+      await develop(options.srcDir, nwDir, options.platform, options.argv);
+    }
+    if (options.mode === "build") {
+      await packager(
+        files,
+        nwDir,
+        options.outDir,
+        options.platform,
+        options.zip,
+        releaseInfo,
+        options.app,
+      );
+    }
+  } catch (error) {
+    log.error(error);
+    return error;
   }
 };
 
-export { nwbuild };
+export default nwbuild;

package/src/run/develop.js

@@ -1,14 +1,30 @@
 import { execute } from "./execute.js";
 import { getPlatformSpecificName } from "./getPlatformSpecificName.js";
 
-const develop = async (srcDir, nwDir, platform) => {
-  if (getPlatformSpecificName(platform) === null) {
-    console.log("Unsupported platform.");
-    return 1;
-  }
+import { log } from "../log.js";
 
-  await execute(srcDir, `${nwDir}/${getPlatformSpecificName(platform)}`);
-  return 0;
+/**
+ * Runs the NW app by spawning a child process
+ *
+ * @param  {string}                  srcDir    The directory to run from
+ * @param  {string}                  nwDir     The directory to run nw.js from
+ * @param  {"win" | "osx" | "linux"} platform  The platform to run for
+ * @param  {string[]}                argv      The arguments to pass to the nw.js development server
+ * @return {Promise<undefined>}
+ */
+const develop = async (srcDir, nwDir, platform, argv) => {
+  try {
+    if (getPlatformSpecificName(platform) === null) {
+      throw new Error("Unsupported platform.");
+    }
+    await execute(
+      srcDir,
+      `${nwDir}/${getPlatformSpecificName(platform)}`,
+      argv,
+    );
+  } catch (error) {
+    log.error(error);
+  }
 };
 
 export { develop };

package/src/run/execute.js

@@ -1,16 +1,32 @@
-import child_process from "node:child_process";
+import { spawn } from "node:child_process";
 
-const execute = (srcDir, nwPath) => {
+import { log } from "../log.js";
+
+/**
+ * Executes the NW.js process
+ * @param  {string}             srcDir  The source directory
+ * @param  {string}             nwPath  The path to the NW.js executable
+ * @param  {string}             argv    The arguments to pass to the NW.js process
+ * @return {Promise<undefined>}         The exit code of the NW.js process
+ * @throws {Error} - If the NW.js process fails to start
+ */
+const execute = (srcDir, nwPath, argv) => {
   return new Promise((resolve, reject) => {
-    const nwProcess = child_process.spawn(nwPath, [srcDir]);
+    // It is assumed that the first glob pattern p contains the package.json at p/package.json
+    srcDir = srcDir.split(" ")[0];
+    srcDir = srcDir.replace(/\*[/*]*/, "");
+    const nwProcess = spawn(nwPath, [srcDir.concat(argv)], {
+      detached: true,
+      windowsHide: true,
+    });
 
     nwProcess.on("close", () => {
-      resolve(0);
+      resolve();
     });
 
     nwProcess.on("error", (error) => {
-      console.log(error);
-      reject(1);
+      log.error(error);
+      reject(error);
     });
   });
 };

package/src/util/arch.js

@@ -0,0 +1,9 @@
+/**
+ * Get user's computer architecture
+ *
+ * @param  {string}                   arch  Node's process.arch
+ * @return {"ia32"| "x64" | "string"}       NW.js supported architectures
+ */
+export const getArch = (arch) => {
+  return arch;
+};

package/src/util/arch.test.js

@@ -0,0 +1,9 @@
+import { getArch } from "./arch.js";
+
+test("x32 arch support", () => {
+  expect(getArch("ia32")).toBe("ia32");
+});
+
+test("x64 arch support", () => {
+  expect(getArch("x64")).toBe("x64");
+});

package/src/util/cache.js

@@ -0,0 +1,17 @@
+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
+ */
+export const isCached = async (nwDir) => {
+  let exists = true;
+  try {
+    await access(nwDir, constants.F_OK);
+  } catch (e) {
+    exists = false;
+  }
+  return exists;
+};

package/src/util/cache.test.js

@@ -0,0 +1,9 @@
+import { isCached } from "./cache.js";
+
+test("directory does not exist", () => {
+  expect(isCached("")).resolves.toBe(false);
+});
+
+test("directory exists", () => {
+  expect(isCached("./test/fixture/cacheDir")).resolves.toBe(true);
+});

package/src/util/parse.js

@@ -0,0 +1,70 @@
+import { arch, cwd, platform } from "node:process";
+
+import { getArch } from "./arch.js";
+import { getPlatform } from "./platform.js";
+
+/**
+ * Parse options
+ *
+ * @param  {import("../nwbuild").Options} options  Options
+ * @param  {object}                       pkg      Package.json as JSON
+ * @return {Promise<object>}                       Options
+ */
+export const parse = async (options, pkg) => {
+  if (typeof pkg?.nwbuild === "object") {
+    options = { ...pkg.nwbuild };
+  }
+
+  options.srcDir = options.srcDir ?? "./";
+  options.mode = options.mode ?? "build";
+  options.version = options.version ?? "latest";
+  options.flavor = options.flavor || "normal";
+  options.platform = options.platform ?? getPlatform(platform);
+  options.arch = options.arch ?? getArch(arch);
+  options.outDir = options.outDir ?? "./out";
+  options.cacheDir = options.cacheDir ?? `${cwd()}/cache`;
+  options.downloadUrl = options.downloadUrl ?? "https://dl.nwjs.io";
+  options.manifestUrl = options.manifestUrl ?? "https://nwjs.io/versions";
+  options.app = {};
+  options.argv = options.argv ?? [];
+  // 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;
+  options.app.icon = options.app.icon ?? undefined;
+  options.app.hidden = options.app.hidden ?? undefined;
+  options.app.onlyShowIn = options.app.onlyShowIn ?? undefined;
+  options.app.notShowIn = options.app.notShowIn ?? undefined;
+  options.app.dBusActivatable = options.app.dBusActivatable ?? undefined;
+  options.app.tryExec = options.app.tryExec ?? undefined;
+  options.app.exec = options.app.name ?? undefined;
+  options.app.path = options.app.path ?? undefined;
+  options.app.terminal = options.app.terminal ?? undefined;
+  options.app.actions = options.app.actions ?? undefined;
+  options.app.mimeType = options.app.mimeType ?? undefined;
+  options.app.categories = options.app.categories ?? undefined;
+  options.app.implements = options.app.implements ?? undefined;
+  options.app.keywords = options.app.keywords ?? undefined;
+  options.app.startupNotify = options.app.startupNotify ?? undefined;
+  options.app.startupWMClass = options.app.startupWMClass ?? undefined;
+  options.app.prefersNonDefaultGPU =
+    options.app.prefersNonDefaultGPU ?? undefined;
+  options.app.singleMainWindow = options.app.singleMainWindow ?? undefined;
+  // windows configuration options
+  options.app.comments = options.app.comments ?? undefined;
+  options.app.company = options.app.company ?? pkg.author;
+  options.app.fileDescription = options.app.fileDescription ?? pkg.description;
+  options.app.fileVersion = options.app.fileVersion ?? pkg.version;
+  options.app.internalName = options.app.internalName ?? pkg.name;
+  options.app.legalCopyright = options.app.legalCopyright ?? undefined;
+  options.app.legalTrademark = options.app.legalTrademark ?? undefined;
+  options.app.originalFilename = options.app.originalFilename ?? pkg.name;
+  options.app.privateBuild = options.app.privateBuild ?? undefined;
+  options.app.productName = options.app.productName ?? pkg.name;
+  options.app.productVersion = options.app.productVersion ?? pkg.version;
+  options.app.specialBuild = options.app.specialBuild ?? undefined;
+  options.cache = options.cache ?? true;
+  options.zip = options.zip ?? false;
+  return options;
+};

package/src/util/parse.test.js

@@ -0,0 +1,5 @@
+import { parse } from "./parse.js";
+
+test("no options passed", () => {
+  expect(parse({})).rejects.toThrow();
+});

package/src/util/platform.js

@@ -0,0 +1,18 @@
+/**
+ * Get user's computer platform
+ *
+ * @param  {string}                            platform  Node's process.platform
+ * @return {"osx"| "win" | "linux" | "string"}           Platform types
+ */
+export const getPlatform = (platform) => {
+  switch (platform) {
+    case "darwin":
+      return "osx";
+    case "win32":
+      return "win";
+    case "linux":
+      return "linux";
+    default:
+      return platform;
+  }
+};