nw-builder 4.11.6 → 4.12.0

package/README.md

@@ -84,7 +84,14 @@ Node manifest usage:
 }
 ```
 
-> From here on we will show `nw-builder` functionality by using the JavaScript module. Please note that the same functionality applies when using a command line or Node manifest.
+See `nw-builder` in action by building the demo application.
+
+1. `git clone https://github.com/nwutils/nw-builder`
+1. Run `npm run demo:bld:linux && npm run demo:exe:linux` to build and execute a Linux application.
+1. Run `npm run demo:bld:osx && npm run demo:exe:osx` to build and execute a MacOS application.
+1. Run `npm run demo:bld:win && npm run demo:exe:win` to build and execute a Windows application.
+
+> From here on we will show `nw-builder` functionality by using the JavaScript module. Please note that the same functionality applies when using a command line or manifest file.
 
 ## Concepts
 
@@ -92,7 +99,7 @@ Node manifest usage:
 
 ### Get Mode
 
-> Deprecation warning: From v4.6.4 onward, run mode is deprecated. This logic has been ported over to `nwjs/npm-installer` repo and will be removed in the next major release.
+> Deprecation warning: From v4.6.4 onward, get mode is deprecated. This logic has been ported over to `nwjs/npm-installer` repo and will be removed in the next major release.
 
 By default you get the normal build of the latest NW.js release for your specific platform and arch. For more information, please refer to the API reference.
 
@@ -125,13 +132,15 @@ nwbuild({
 > Deprecation warning: From v4.6.0 onward, run mode is deprecated. This logic has been ported over to `nwjs/npm-installer` repo and will be removed in the next major release.
 
 ```javascript
-nwbuild({
+const nwProcess = await nwbuild({
   mode: "run",
   srcDir: "./app",
   glob: false,
 });
 ```
 
+Note: The `nwProcess` is a [Node.js process](https://nodejs.org/api/process.html#process)
+
 ### Build Mode
 
 Build with defaults:
@@ -142,7 +151,7 @@ nwbuild({
 });
 ```
 
-Managed Manifest
+#### Managed Manifest
 
 You can let `nw-builder` manage your node modules. The `managedManifest` options accepts a `boolean`, `string` or `object` type. It will then remove `devDependencies`, autodetect and download `dependencies` via the relevant `packageManager`. If none is specified, it uses `npm` as default.
 
@@ -176,7 +185,7 @@ nwbuild({
 });
 ```
 
-Rebuild Node addons
+#### Rebuild Node addons
 
 Currently this feature is quite limited. It only builds node addons which have a `binding.gyp` file in the `srcDir`. There are plans to support nan, cmake, ffi and gn and auto rebuild native addons which are installed as node modules.
 
@@ -201,7 +210,6 @@ Options
 
 | Name | Type    | Default   | Description |
 | ---- | ------- | --------- | ----------- |
-| app | `LinuxRc \| WinRc \| OsxRc` | Additional options for each platform. (See below.)
 | mode | `"get" \| "run" \| "build"` | `"build"` | Choose between get, run or build mode |
 | version | `string \| "latest" \| "stable"` | `"latest"` | Runtime version |
 | flavor | `"normal" \| "sdk"` | `"normal"` | Runtime flavor |
@@ -210,15 +218,17 @@ Options
 | downloadUrl | `"https://dl.nwjs.io" \| "https://npm.taobao.org/mirrors/nwjs" \| https://npmmirror.com/mirrors/nwjs \| "https://github.com/corwin-of-amber/nw.js/releases/"` | `"https://dl.nwjs.io"` | Download server. Supports file systems too (for example `file:///home/localghost/nwjs_mirror`) |
 | manifestUrl | `"https://nwjs.io/versions" \| "https://raw.githubusercontent.com/nwutils/nw-builder/main/src/util/osx.arm.versions.json"` | `"https://nwjs.io/versions"` | Versions manifest |
 | cacheDir | `string` | `"./cache"` | Directory to cache NW binaries |
+| cache | `boolean` | `true`| If true the existing cache is used. Otherwise it removes and redownloads it. |
+| ffmpeg | `boolean` | `false`| If true the chromium ffmpeg is replaced by community version with proprietary codecs. |
+| logLevel | `"error" \| "warn" \| "info" \| "debug"` | `"info"`| Specify level of logging. |
 | srcDir | `string` | `"./"` | File paths to application code |
+| argv | `string[]` | `[]` | Command line arguments to pass to NW executable in run mode. You can also define these in `chromium-args` in NW.js manifest. |
+| glob | `boolean` | `true`| If true file globbing is enabled when parsing `srcDir`. |
 | outDir | `string` | `"./out"` | Directory to store build artifacts |
 | managedManifest | `boolean \| string \| object` | `false` | Managed manifest |
 | nodeAddon | `false \| "gyp"` | `false` | Rebuild Node native addons |
-| cache | `boolean` | `true`| If true the existing cache is used. Otherwise it removes and redownloads it. |
-| ffmpeg | `boolean` | `false`| If true the chromium ffmpeg is replaced by community version with proprietary codecs. |
-| glob | `boolean` | `true`| If true file globbing is enabled when parsing `srcDir`. |
-| logLevel | `"error" \| "warn" \| "info" \| "debug"` | `"info"`| Specify level of logging. |
 | zip | `boolean \| "zip" \| "tar" \| "tgz"` | `false`| If true, "zip", "tar" or "tgz" the `outDir` directory is compressed. |
+| app | `LinuxRc \| WinRc \| OsxRc` | Additional options for each platform. (See below.)
 
 ### `app` configuration object
 
@@ -228,20 +238,20 @@ This object defines additional properties used for building for a specific platf
 
 | Name | Type    | Default   | Description |
 | ---- | ------- | --------- | ----------- |
-| `icon` | `string` | `undefined` | The path to the icon file. It should be a .ico file. |
-| `name` | `string` | Value of `name` in app's `package.json` | The name of the application |
-| `version` | `string` | Value of `version` in app's `package.json` | (deprecated, Use `fileVersion` instead) The version of the application |
+| `icon` | `string` | `undefined` | The path to the icon file. It should be a .ico file. (**WARNING**: Please define the icon in the NW.js manifest instead) |
+| `name` | `string` | Value of `name` in NW.js manifest | The name of the application |
+| `version` | `string` | Value of `version` in NW.js manifest | The version of the application |
 | `comments` | `string` | `undefined` | Additional information that should be displayed for diagnostic purposes. |
-| `company` | `string` | Value of `author` in app's `package.json` | Company that produced the file—for example, Microsoft Corporation or Standard Microsystems Corporation, Inc. This string is required. |
-| `fileDescription` | `string` | Value of `description` in app's `package.json` | 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. |
-| `fileVersion` | `string` | Value of `version` option or value of `version` in app's `package.json` | Version number of the file. For example, 3.10 or 5.00.RC2. This string is required. |
-| `internalName` | `string` | Value of `name` in app's `package.json` |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. |
-| `legalCopyright` | `string` | NW.js' copyright info | 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. |
+| `company` | `string` | Value of `author` in NW.js manifest | Company that produced the file—for example, Microsoft Corporation or Standard Microsystems Corporation, Inc. This string is required. |
+| `fileDescription` | `string` | Value of `description` in NW.js manifest | 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. |
+| `fileVersion` | `string` | Value of `version` or value of `version` in NW.js manifest | Version number of the file. For example, 3.10 or 5.00.RC2. This string is required. |
+| `internalName` | `string` | Value of `name` in NW.js manifest |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. |
+| `legalCopyright` | `string` | `undefined` | 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. |
 | `legalTrademark` | `string` | `undefined` | 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. |
 | `originalFilename` | `string` | Value of `name` option | 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. |
 | `privateBuild` | `string` | `undefined` | Information about a private version of the file—for example, Built by TESTER1 on \\TESTBED. |
-| `productName` | `string` | Matches the package name defined in app's `package.json` | Name of the product with which the file is distributed. This string is required. |
-| `productVersion` | `string` | Value of `version` in app's `package.json` | Version of the product with which the file is distributed—for example, 3.10 or 5.00.RC2. |
+| `productName` | `string` | `name` in NW.js manifest | Name of the product with which the file is distributed. This string is required. |
+| `productVersion` | `string` | Value of `version` in NW.js manifest | Version of the product with which the file is distributed—for example, 3.10 or 5.00.RC2. |
 | `specialBuild` | `string` | `undefined` | 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. |
 | `languageCode` | `number` | `1033` | Language of the file, defined by Microsoft, see: https://learn.microsoft.com/en-us/openspecs/office_standards/ms-oe376/6c085406-a698-4e12-9d4d-c3b0ee3dbc4a                                                                                                 |
 
@@ -253,7 +263,7 @@ This object defines additional properties used for building for a specific platf
 | genericName | `string` | Generic name of the application |
 | noDisplay | `boolean` | If true the application is not displayed |
 | comment | `string` | Tooltip for the entry, for example "View sites on the Internet". |
-| icon | `string` | Icon to display in file manager, menus, etc. |
+| icon | `string` | Icon to display in file manager, menus, etc. (**WARNING**: Please define the icon in the NW.js manifest instead) |
 | hidden | `boolean` | TBD |
 | onlyShowIn | `string[]` | A list of strings identifying the desktop environments that should display a given desktop entry |
 | notShowIn | `string[]` | A list of strings identifying the desktop environments that should not display a given desktop entry |
@@ -277,7 +287,7 @@ This object defines additional properties used for building for a specific platf
 | Name | Type    | Description |
 | ---- | ------- | ----------- |
 | name | `string` | The name of the application |
-| icon | `string` | The path to the icon file. It should be a .icns file. |
+| icon | `string` | The path to the icon file. It should be a .icns file. (**WARNING**: Please define the icon in the NW.js manifest instead) |
 | LSApplicationCategoryType | `string` | The category that best describes your app for the App Store. |
 | CFBundleIdentifier | `string` | A unique identifier for a bundle usually in reverse DNS format. |
 | CFBundleName | `string` | A user-visible short name for the bundle. |
@@ -385,7 +395,6 @@ nwbuild({
 
 ### Chores
 
-- chore: add Linux, MacOS and Windows fixtures
 - chore(docs): don't store JSDoc definitions in `typedef`s - get's hard to understand during development.
 - chore: annotate file paths as `fs.PathLike` instead of `string`.
 - chore(bld): factor out core build step

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nw-builder",
-  "version": "4.11.6",
+  "version": "4.12.0",
   "description": "Build NW.js desktop applications for MacOS, Windows and Linux.",
   "keywords": [
     "NW.js",
@@ -46,17 +46,21 @@
     "lint:fix": "eslint --fix ./src ./tests",
     "test": "vitest run --coverage",
     "test:cov": "vitest --coverage.enabled true",
-    "demo:bld": "node ./tests/fixtures/demo.js",
-    "demo:exe": "./tests/fixtures/out/Demo.app/Contents/MacOS/Demo",
+    "demo:bld:linux": "node ./tests/fixtures/demo.linux.js",
+    "demo:bld:osx": "node ./tests/fixtures/demo.osx.js",
+    "demo:bld:win": "node ./tests/fixtures/demo.win.js",
+    "demo:exe:linux": "./tests/fixtures/out/linux/Demo",
+    "demo:exe:osx": "./tests/fixtures/out/osx/Demo.app/Contents/MacOS/Demo",
+    "demo:exe:win": "./tests/fixtures/out/win/Demo.exe",
     "demo:cli": "nwbuild --mode=run --flavor=sdk --glob=false --cacheDir=./node_modules/nw ./tests/fixtures/app"
   },
   "devDependencies": {
-    "@eslint/js": "^9.12.0",
-    "@vitest/coverage-v8": "^2.1.2",
+    "@eslint/js": "^9.15.0",
+    "@vitest/coverage-v8": "^2.1.5",
     "base-volta-off-of-nwjs": "^1.0.5",
-    "eslint": "^9.12.0",
-    "eslint-plugin-jsdoc": "^50.3.2",
-    "globals": "^15.11.0",
+    "eslint": "^9.15.0",
+    "eslint-plugin-jsdoc": "^50.5.0",
+    "globals": "^15.12.0",
     "nw": "^0.93.0",
     "selenium-webdriver": "^4.25.0",
     "vitest": "^2.0.4"

package/src/bld.js

@@ -62,11 +62,11 @@ import setOsxConfig from './bld/osx.js';
  * References:
  * 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-us/visualstudio/deployment/trustinfo-element-clickonce-application?view=vs-2022#requestedexecutionlevel
  * https://learn.microsoft.com/en-gb/windows/win32/menurc/versioninfo-resource
  * @typedef {object} WinRc              Windows configuration options. More info
  * @property {string} name              The name of the application
- * @property {string} version           @deprecated Use {@link fileVersion} instead. The version 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.
@@ -256,13 +256,13 @@ const setLinuxConfig = async ({ app, outDir }) => {
     GenericName: app.genericName,
     NoDisplay: app.noDisplay,
     Comment: app.comment,
-    Icon: app.icon,
+    Icon: path.resolve(outDir, 'package.nw', path.basename(app.icon)),
     Hidden: app.hidden,
     OnlyShowIn: app.onlyShowIn,
     NotShowIn: app.notShowIn,
     DBusActivatable: app.dBusActivatable,
     TryExec: app.tryExec,
-    Exec: app.name,
+    Exec: app.exec,
     Path: app.path,
     Terminal: app.terminal,
     Actions: app.actions,
@@ -319,10 +319,11 @@ const setWinConfig = async ({ app, outDir }) => {
   if (app.icon) {
     const iconBuffer = await fs.promises.readFile(path.resolve(app.icon));
     const iconFile = resedit.Data.IconFile.from(iconBuffer);
+    const iconGroupIDs = resedit.Resource.IconGroupEntry.fromEntries(res.entries).map((entry) => entry.id);
     resedit.Resource.IconGroupEntry.replaceIconsForResource(
       res.entries,
-      // This is the name of the icon group nw.js uses that gets shown in file exlorers
-      'IDR_MAINFRAME',
+      /*  Should be `IDR_MAINFRAME` */
+      iconGroupIDs[0],
       EN_US,
       iconFile.icons.map(i => i.data)
     );

package/src/get/request.js

@@ -1,4 +1,5 @@
 import fs from 'node:fs';
+import process from 'node:process';
 import stream from 'node:stream';
 
 import axios from 'axios';
@@ -15,6 +16,15 @@ export default async function request(url, filePath) {
 
   const writeStream = fs.createWriteStream(filePath);
 
+  /* Listen for SIGINT (Ctrl+C) */
+  process.on('SIGINT', function () {
+    /* Delete file if it exists. This prevents unnecessary `Central Directory not found` errors. */
+    if (fs.existsSync(filePath)) {
+      fs.unlinkSync(filePath);
+    }
+    process.exit();
+  });
+
   const response = await axios({
     method: 'get',
     url: url,
@@ -22,4 +32,5 @@ export default async function request(url, filePath) {
   });
 
   await stream.promises.pipeline(response.data, writeStream);
+
 }

package/src/index.d.ts

@@ -61,7 +61,7 @@ export type AppOptions<P extends SupportedPlatform> =
 export interface WindowsAppOptions {
     /** The name of the application */
     name?: string,
-    /** @deprecated Use {@link fileVersion} instead. The version of the application */
+    /** The version of the application */
     version?: string,
     /** Additional information that should be displayed for diagnostic purposes. */
     comments?: string,

package/src/index.js

@@ -1,5 +1,6 @@
 import console from 'node:console';
 import fs from 'node:fs';
+import path from 'node:path';
 
 import bld from './bld.js';
 import get from './get/index.js';
@@ -45,17 +46,19 @@ async function nwbuild(options) {
   };
 
   try {
-    // Parse options
+    /* Parse options */
     options = await util.parse(options, manifest);
+    util.log('debug', 'info', 'Parse initial options');
 
+    util.log('debug', 'info', 'Get node manifest...');
     manifest = await util.getNodeManifest({ srcDir: options.srcDir, glob: options.glob });
     if (typeof manifest.json?.nwbuild === 'object') {
       options = manifest.json.nwbuild;
     }
 
+    util.log('info', options.logLevel, 'Parse final options using node manifest');
     options = await util.parse(options, manifest.json);
-
-    //TODO: impl logging
+    util.log('debug', options.logLevel, 'Manifest: ', `${manifest.path}\n${manifest.json}\n`);
 
     built = fs.existsSync(options.cacheDir);
     if (built === false) {
@@ -69,7 +72,8 @@ async function nwbuild(options) {
       }
     }
 
-    // Validate options.version to get the version specific release info
+    /* Validate options.version to get the version specific release info */
+    util.log('info', options.logLevel, 'Get version specific release info...');
     releaseInfo = await util.getReleaseInfo(
       options.version,
       options.platform,
@@ -77,13 +81,16 @@ async function nwbuild(options) {
       options.cacheDir,
       options.manifestUrl,
     );
+    util.log('debug', options.logLevel, `Release info:\n${JSON.stringify(releaseInfo, null, 2)}\n`);
 
+    util.log('info', options.logLevel, 'Validate options.* ...');
     await util.validate(options, releaseInfo);
+    util.log('debug', options.logLevel, `Options:\n${JSON.stringify(options, null, 2)}`);
 
-    // Remove leading "v" from version string
+    /* Remove leading "v" from version string */
     options.version = releaseInfo.version.slice(1);
 
-    // Download binaries
+    util.log('info', options.logLevel, 'Getting NW.js and related binaries...');
     await get({
       version: options.version,
       flavor: options.flavor,
@@ -102,6 +109,7 @@ async function nwbuild(options) {
     }
 
     if (options.mode === 'run') {
+      util.log('info', options.logLevel, 'Running NW.js in run mode...');
       await run({
         version: options.version,
         flavor: options.flavor,
@@ -113,6 +121,7 @@ async function nwbuild(options) {
         argv: options.argv,
       });
     } else if (options.mode === 'build') {
+      util.log('info', options.logLevel, `Build a NW.js application for ${options.platform} ${options.arch}...`);
       await bld({
         version: options.version,
         flavor: options.flavor,
@@ -129,6 +138,7 @@ async function nwbuild(options) {
         zip: options.zip,
         releaseInfo: releaseInfo,
       });
+      util.log('info', options.logLevel, `Appliction is available at ${path.resolve(options.outDir)}`);
     }
   } catch (error) {
     console.error(error);

package/src/run.js

@@ -23,7 +23,7 @@ import util from './util.js';
  * @async
  * @function
  * @param  {RunOptions}    options  Run mode options
- * @returns {Promise<void>}
+ * @returns {Promise<child_process.ChildProcess | null>} - A Node.js process object
  */
 async function run({
   version = 'latest',
@@ -35,6 +35,11 @@ async function run({
   glob = false,
   argv = [],
 }) {
+  /**
+   * @type {child_process.ChildProcess | null}
+   */
+  let nwProcess = null;
+  
   try {
     if (util.EXE_NAME[platform] === undefined) {
       throw new Error('Unsupported platform.');
@@ -49,8 +54,8 @@ 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(
+      /* It is assumed that the package.json is located at `${options.srcDir}/package.json` */
+      nwProcess = child_process.spawn(
         path.resolve(nwDir, util.EXE_NAME[platform]),
         [...[srcDir], ...argv],
         { stdio: 'inherit' },
@@ -68,6 +73,7 @@ async function run({
   } catch (error) {
     console.error(error);
   }
+  return nwProcess;
 }
 
 export default run;

package/src/util.js

@@ -172,16 +172,16 @@ async function getNodeManifest({
  * @param {any} option - a boolean type option
  * @returns {any} Usually `undefined`, `true` or `false`. if not then it is validated later on.
  */
-function str2Bool (option) {
+function str2Bool(option) {
   if (typeof option === 'string') {
     if (option === 'true') {
       return true;
     } else if (option === 'false') {
       return false;
-    } 
+    }
   } else {
     return option;
-  } 
+  }
 }
 
 /**
@@ -230,7 +230,8 @@ export const parse = async (options, pkg) => {
     /* Remove special and control characters from app.name to mitigate potential path traversal. */
     options.app.name = options.app.name.replace(/[<>:"/\\|?*\u0000-\u001F]/g, '');
   }
-  options.app.icon = options.app.icon ?? undefined;
+  /* Path to where the icon currently is in the filesystem */
+  options.app.icon = path.resolve(options.app.icon) ?? undefined;
 
   // TODO(#737): move this out
   if (options.platform === 'linux') {
@@ -243,7 +244,7 @@ export const parse = async (options, pkg) => {
     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.exec = path.resolve(options.app.exec) ?? undefined;
     options.app.path = options.app.path ?? undefined;
     options.app.terminal = options.app.terminal ?? undefined;
     options.app.actions = options.app.actions ?? undefined;
@@ -306,7 +307,11 @@ export const parse = async (options, pkg) => {
  * @throws {Error}                                         Throw error if options are invalid
  */
 export const validate = async (options, releaseInfo) => {
-  if (!['get', 'run', 'build'].includes(options.mode)) {
+  if (
+    options.mode !== 'get' &&
+    options.mode !== 'run' &&
+    options.mode !== 'build'
+  ) {
     throw new Error(
       `Unknown mode ${options.mode}. Expected "get", "run" or "build".`,
     );
@@ -330,16 +335,23 @@ export const validate = async (options, releaseInfo) => {
       `Platform ${options.platform} and architecture ${options.arch} is not supported by this download server.`,
     );
   }
-  // if (typeof options.cacheDir !== "string") {
-  //   throw new Error("Expected options.cacheDir to be a string. Got " + typeof options.cacheDir);
-  // }
+  if (typeof options.downloadUrl === 'string' && !options.downloadUrl.startsWith('http') && !options.downloadUrl.startsWith('file')) {
+    throw new Error('Expected options.downloadUrl to be a string and starts with `http` or `file`.');
+  }
+  if (typeof options.manifestUrl === 'string' && !options.manifestUrl.startsWith('http') && !options.manifestUrl.startsWith('file')) {
+    throw new Error('Expected options.manifestUrl to be a string and starts with `http` or `file`.');
+  }
+  if (typeof options.cacheDir !== 'string') {
+    throw new Error('Expected options.cacheDir to be a string. Got ' + typeof options.cacheDir);
+  }
+
   if (typeof options.cache !== 'boolean') {
-    return new Error(
+    throw new Error(
       'Expected options.cache to be a boolean. Got ' + typeof options.cache,
     );
   }
   if (typeof options.ffmpeg !== 'boolean') {
-    return new Error(
+    throw new Error(
       'Expected options.ffmpeg to be a boolean. Got ' + typeof options.ffmpeg,
     );
   }
@@ -359,27 +371,26 @@ export const validate = async (options, releaseInfo) => {
   if (options.mode === 'get') {
     return undefined;
   }
+  if (typeof options.srcDir !== 'string') {
+    throw new Error('Expected options.srcDir to be a string. Got ' + typeof options.srcDir);
+  }
   if (Array.isArray(options.argv)) {
-    return new Error(
+    throw new Error(
       'Expected options.argv to be an array. Got ' + typeof options.argv,
     );
   }
   if (typeof options.glob !== 'boolean') {
-    return new Error(
+    throw new Error(
       'Expected options.glob to be a boolean. Got ' + typeof options.glob,
     );
   }
 
-  if (options.srcDir) {
-    await fs.promises.readdir(options.srcDir);
-  }
-
   if (options.mode === 'run') {
     return undefined;
   }
 
-  if (options.outDir) {
-    await fs.promises.readdir(options.outDir);
+  if (typeof options.outDir !== 'string') {
+    throw new Error('Expected options.outDir to be a string. Got ' + typeof options.outDir);
   }
 
   if (
@@ -387,7 +398,7 @@ export const validate = async (options, releaseInfo) => {
     typeof options.managedManifest !== 'object' &&
     typeof options.managedManifest !== 'string'
   ) {
-    return new Error(
+    throw new Error(
       'Expected options.managedManifest to be a boolean, object or string. Got ' +
       typeof options.managedManifest,
     );
@@ -395,24 +406,184 @@ export const validate = async (options, releaseInfo) => {
 
   if (typeof options.managedManifest === 'object') {
     if (options.managedManifest.name === undefined) {
-      return new Error('Expected NW.js Manifest to have a `name` property.');
+      throw new Error('Expected NW.js Manifest to have a `name` property.');
     }
     if (options.managedManifest.main === undefined) {
-      return new Error('Expected NW.js Manifest to have a `main` property.');
+      throw new Error('Expected NW.js Manifest to have a `main` property.');
     }
   }
 
   if (typeof options.nativeAddon !== 'boolean') {
     if (typeof options.nativeAddon !== 'boolean' && typeof options.nativeAddon !== 'string') {
-      return new Error('Expected options.nativeAddon to be a boolean or string type. Got ' + typeof options.nativeAddon);
+      throw new Error('Expected options.nativeAddon to be a boolean or string type. Got ' + typeof options.nativeAddon);
     }
 
     if (semver.parse(options.version).minor >= '83' && options.nativeAddon !== false) {
-      return new Error('Native addons are not supported for NW.js v0.82.0 and below');
+      throw new Error('Native addons are not supported for NW.js v0.82.0 and below');
+    }
+
+    if (typeof options.zip !== 'boolean' &
+      options.zip !== 'zip' &&
+      options.zip !== 'tar' &&
+      options.zip !== 'tgz') {
+      throw new Error('Expected options.zip to be a boolean, `zip`, `tar` or `tgz`. Got ' + typeof options.zip);
     }
   }
 
-  // TODO: Validate app options
+  if (options.platform === 'linux') {
+    if (options.app.name && typeof options.app.name !== 'string') {
+      throw new Error('Expected options.app.name to be a string. Got ' + options.app.name);
+    }
+    if (options.app.genericName && typeof options.app.genericName !== 'string') {
+      throw new Error('Expected options.app.genericName to be a string. Got ' + options.app.genericName);
+    }
+    if (options.app.noDisplay && typeof options.app.noDisplay !== 'boolean') {
+      throw new Error('Expected options.app.noDisplay to be a boolean. Got ' + options.app.noDisplay);
+    }
+    if (options.app.comment && typeof options.app.comment !== 'string') {
+      throw new Error('Expected options.app.comment to be a string. Got ' + options.app.comment);
+    }
+    if (options.app.icon && typeof options.app.icon !== 'string') {
+      throw new Error('Expected options.app.icon to be a string. Got ' + options.app.icon);
+    }
+    if (options.app.hidden && typeof options.app.hidden !== 'string') {
+      throw new Error('Expected options.app.hidden to be a string. Got ' + options.app.hidden);
+    }
+    if (options.app.onlyShowIn && Array.isArray(options.app.onlyShowIn)) {
+      throw new Error('Expected options.app.onlyShowIn to be an Array<string>. Got ' + options.app.onlyShowIn);
+    }
+    if (options.app.notShowIn && Array.isArray(options.app.notShowIn)) {
+      throw new Error('Expected options.app.notShowIn to be an Array<string>. Got ' + options.app.notShowIn);
+    }
+    if (options.app.dBusActivatable && typeof options.app.dBusActivatable !== 'boolean') {
+      throw new Error('Expected options.app.dBusActivatable to be a boolean. Got ' + options.app.dBusActivatable);
+    }
+    if (options.app.tryExec && typeof options.app.tryExec !== 'string') {
+      throw new Error('Expected options.app.tryExec to be a string. Got ' + options.app.tryExec);
+    }
+    if (options.app.exec && typeof options.app.exec !== 'string') {
+      throw new Error('Expected options.app.exec to be a string. Got ' + options.app.exec);
+    }
+    if (options.app.path && typeof options.app.path !== 'string') {
+      throw new Error('Expected options.app.path to be a string. Got ' + options.app.path);
+    }
+    if (options.app.terminal && typeof options.app.terminal !== 'boolean') {
+      throw new Error('Expected options.app.terminal to be a boolean. Got ' + options.app.terminal);
+    }
+    if (options.app.actions && Array.isArray(options.app.actions)) {
+      throw new Error('Expected options.app.actions to be a Array<string>. Got ' + options.app.actions);
+    }
+    if (options.app.mimeType && Array.isArray(options.app.mimeType)) {
+      throw new Error('Expected options.app.mimeType to be a Array<string>. Got ' + options.app.mimeType);
+    }
+    if (options.app.categories && Array.isArray(options.app.categories)) {
+      throw new Error('Expected options.app.categories to be a Array<string>. Got ' + options.app.categories);
+    }
+    if (options.app.implements && Array.isArray(options.app.implements)) {
+      throw new Error('Expected options.app.implements to be a Array<string>. Got ' + options.app.implements);
+    }
+    if (options.app.keywords && Array.isArray(options.app.keywords)) {
+      throw new Error('Expected options.app.keywords to be a Array<string>. Got ' + options.app.keywords);
+    }
+    if (options.app.startupNotify && typeof options.app.startupNotify !== 'boolean') {
+      throw new Error('Expected options.app.startupNotify to be a boolean. Got ' + options.app.startupNotify);
+    }
+    if (options.app.startupWMClass && typeof options.app.startupWMClass !== 'string') {
+      throw new Error('Expected options.app.startupWMClass to be a string. Got ' + options.app.startupWMClass);
+    }
+    if (options.app.prefersNonDefaultGPU && typeof options.app.prefersNonDefaultGPU !== 'boolean') {
+      throw new Error('Expected options.app.prefersNonDefaultGPU to be a boolean. Got ' + options.app.prefersNonDefaultGPU);
+    }
+    if (options.app.singleMainWindow && typeof options.app.singleMainWindow !== 'string') {
+      throw new Error('Expected options.app.singleMainWindow to be a string. Got ' + options.app.singleMainWindow);
+    }
+  } else if (options.platform === 'osx') {
+    if (typeof options.app.name !== 'string') {
+      throw new Error('Expected options.app.name to be a string. Got ' + options.app.name);
+    }
+    if (typeof options.app.icon !== 'string') {
+      throw new Error('Expected options.app.icon to be a string. Got ' + options.app.icon);
+    }
+    if (typeof options.app.LSApplicationCategoryType !== 'string') {
+      throw new Error('Expected options.app.LSApplicationCategoryType to be a string. Got ' + options.app.LSApplicationCategoryType);
+    }
+    if (typeof options.app.CFBundleIdentifier !== 'string') {
+      throw new Error('Expected options.app.CFBundleIdentifier to be a string. Got ' + options.app.CFBundleIdentifier);
+    }
+    if (typeof options.app.CFBundleName !== 'string') {
+      throw new Error('Expected options.app.CFBundleName to be a string. Got ' + options.app.CFBundleName);
+    }
+    if (typeof options.app.CFBundleDisplayName !== 'string') {
+      throw new Error('Expected options.app.CFBundleDisplayName to be a string. Got ' + options.app.CFBundleDisplayName);
+    }
+    if (typeof options.app.CFBundleSpokenName !== 'string') {
+      throw new Error('Expected options.app.CFBundleSpokenName to be a string. Got ' + options.app.CFBundleSpokenName);
+    }
+    if (typeof options.app.CFBundleVersion !== 'string') {
+      throw new Error('Expected options.app.CFBundleVersion to be a string. Got ' + options.app.CFBundleVersion);
+    }
+    if (typeof options.app.CFBundleShortVersionString !== 'string') {
+      throw new Error('Expected options.app.CFBundleShortVersionString to be a string. Got ' + options.app.CFBundleShortVersionString);
+    }
+    if (typeof options.app.NSHumanReadableCopyright !== 'string') {
+      throw new Error('Expected options.app.NSHumanReadableCopyright to be a string. Got ' + options.app.NSHumanReadableCopyright);
+    }
+    if (typeof options.app.NSLocalNetworkUsageDescription !== 'string') {
+      throw new Error('Expected options.app.NSLocalNetworkUsageDescription to be a string. Got ' + options.app.NSLocalNetworkUsageDescription);
+    }
+  } else {
+    if (typeof options.app.name !== 'string') {
+      throw new Error('Expected options.app.name to be a string. Got ' + options.app.name);
+    }
+    if (typeof options.app.icon !== 'string') {
+      throw new Error('Expected options.app.icon to be a string. Got ' + options.app.icon);
+    }
+    if (typeof options.app.version !== 'string') {
+      throw new Error('Expected options.app.version to be a string. Got ' + options.app.version);
+    }
+    if (options.app.comments && typeof options.app.comments !== 'string') {
+      throw new Error('Expected options.app.comments to be a string. Got ' + options.app.comments);
+    }
+    if (typeof options.app.company !== 'string') {
+      throw new Error('Expected options.app.company to be a string. Got ' + options.app.company);
+    }
+    if (typeof options.app.fileDescription !== 'string') {
+      throw new Error('Expected options.app.fileDescription to be a string. Got ' + options.app.fileDescription);
+    }
+    if (typeof options.app.fileVersion !== 'string') {
+      throw new Error('Expected options.app.fileVersion to be a string. Got ' + options.app.fileVersion);
+    }
+    if (typeof options.app.internalName !== 'string') {
+      throw new Error('Expected options.app.internalName to be a string. Got ' + options.app.internalName);
+    }
+    if (options.app.legalCopyright && typeof options.app.legalCopyright !== 'string') {
+      throw new Error('Expected options.app.legalCopyright to be a string. Got ' + options.app.legalCopyright);
+    }
+    if (options.app.legalTrademark && typeof options.app.legalTrademark !== 'string') {
+      throw new Error('Expected options.app.legalTrademark to be a string. Got ' + options.app.legalTrademark);
+    }
+    if (typeof options.app.originalFilename !== 'string') {
+      throw new Error('Expected options.app.originalFilename to be a string. Got ' + options.app.originalFilename);
+    }
+    if (typeof options.app.privateBuild !== 'string') {
+      throw new Error('Expected options.app.privateBuild to be a string. Got ' + options.app.privateBuild);
+    }
+    if (typeof options.app.productName !== 'string') {
+      throw new Error('Expected options.app.productName to be a string. Got ' + options.app.productName);
+    }
+    if (typeof options.app.productVersion !== 'string') {
+      throw new Error('Expected options.app.productVersion to be a string. Got ' + options.app.productVersion);
+    }
+    if (options.app.specialBuild && typeof options.app.specialBuild !== 'string') {
+      throw new Error('Expected options.app.specialBuild to be a string. Got ' + options.app.specialBuild);
+    }
+    if (typeof options.app.legalCopyright !== 'string') {
+      throw new Error('Expected options.app.legalCopyright to be a string. Got ' + options.app.legalCopyright);
+    }
+    if (typeof options.app.languageCode !== 'number') {
+      throw new Error('Expected options.app.languageCode to be a number. Got ' + options.app.languageCode);
+    }
+  }
   return undefined;
 };
 
@@ -453,4 +624,39 @@ async function fileExists(filePath) {
   return exists;
 }
 
-export default { fileExists, getReleaseInfo, getPath, PLATFORM_KV, ARCH_KV, EXE_NAME, globFiles, getNodeManifest, parse, validate };
+/**
+ * Custom logging function
+ * @param {'debug' | 'info' | 'warn' | 'error'} severity - severity of message
+ * @param {'debug' | 'info' | 'warn' | 'error'} logLevel - log level requested by user
+ * @param {string} message - contents of message
+ * @throws {Error} - throw error on invalid input
+ * @returns {string} - stdout
+ */
+function log(severity, logLevel, message) {
+  if (!['debug', 'info', 'warn', 'error'].includes(severity)) {
+    throw new Error(`Expected debug, info, warn or error message severity. Got ${severity}`);
+  }
+  if (!['debug', 'info', 'warn', 'error'].includes(logLevel)) {
+    throw new Error(`Expected debug, info, warn or error user defined log level. Got ${logLevel}`);
+  }
+
+  const sev = {
+    'debug': 4,
+    'info': 3,
+    'warn': 2,
+    'error': 1,
+  };
+  let stdout = '';
+  const messageSeverity = sev[severity];
+  const userDefSeverity = sev[logLevel];
+
+  if (messageSeverity <= userDefSeverity) {
+    stdout = `[ ${severity.toUpperCase()} ] ${message}`;
+  }
+
+  console.log(stdout);
+
+  return stdout;
+}
+
+export default { fileExists, getReleaseInfo, getPath, PLATFORM_KV, ARCH_KV, EXE_NAME, globFiles, getNodeManifest, parse, validate, log };