nw-builder 3.5.6 → 3.7.0

package/README.md

@@ -1,52 +1,79 @@
-# nw-builder [![NPM version][npm-image]][npm-url] [![Dependency Status][depstat-image]][depstat-url] [![Join the chat at https://gitter.im/nwjs/nw-builder](https://badges.gitter.im/nwjs/nw-builder.svg)](https://gitter.im/nwjs/nw-builder?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+# nw-builder
 
-[![NPM](https://nodei.co/npm/nw-builder.png?downloads=true)](https://nodei.co/npm/nw-builder/)
+[![npm](https://img.shields.io/npm/v/nw-builder.svg?style=flat)](https://www.npmjs.com/package/nw-builder)
+[![ci](https://github.com/nwjs-community/nw-builder/actions/workflows/ci.yml/badge.svg)](https://github.com/nwjs-community/nw-builder/actions/workflows/ci.yml)
+[![cd](https://github.com/nwjs-community/nw-builder/actions/workflows/cd.yml/badge.svg)](https://github.com/nwjs-community/nw-builder/actions/workflows/cd.yml)
+[![Join the chat at https://gitter.im/nwjs/nw-builder](https://badges.gitter.im/nwjs/nw-builder.svg)](https://gitter.im/nwjs/nw-builder?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-> Build your [NW.js](https://github.com/nwjs/nw.js) apps for Mac, Win and Linux programmatically or via CLI.
+Build [NW.js](https://github.com/nwjs/nw.js) applications for Mac, Windows and Linux.
 
+## Table of Contents
 
-### Installation
+- [Installation](https://github.com/nwutils/nw-builder#installation)
+- [Usage](https://github.com/nwutils/nw-builder#usage)
+- [API Reference](https://github.com/nwutils/nw-builder#api-reference)
+- [Contributing](https://github.com/nwutils/nw-builder#contributing)
+- [License](https://github.com/nwutils/nw-builder#license)
 
-##### Local
-```shell
-npm install nw-builder --save-dev
+## Installation
+
+> Tested and runs on Node 14, 16 and 18!
+
+Using npm:
+
+```javascript
+npm install nw-builder
 ```
 
-##### Global
-```shell
-npm install nw-builder -g
+Using yarn:
+
+```javascript
+yarn add nw-builder
 ```
 
-##### Grunt and Gulp Plugins
-Yes, there is also a [Grunt Plugin](https://github.com/nwjs/grunt-nw-builder). For Gulp, just use the module :)
+Using pnpm:
+
+```javascript
+pnpm add nw-builder
+```
 
+## Usage
 
-## CLI Usage
+### CLI
 
 ```shell
-Usage: nwbuild [options] [path]
+Usage:
+  nwbuild [options] [path] [-- <args>]
 
 Options:
-  -p, --platforms      Platforms to build, comma-sperated, can be: win32,win64,osx32,osx64,linux32,linux64   ['osx64', 'win32', 'win64']
-  -v, --version        The nw version, eg. 0.8.4                                             [default: "latest"]
-  -r, --run            Runs NW.js for the current platform                                   [default: false]
-  -o, --buildDir       The build folder                                                      [default: "./build"]
-  -f, --forceDownload  Force download of NW.js                                               [default: false]
+  -p, --platforms      Platforms to build, comma-sperated, can be:
+                       win32, win64, osx32, osx64, linux32, linux64 or
+                       win, osx, linux                                       [default: <Current OS>]
+  -v, --version        The nw version, eg. 0.64.1                                 [default: "latest"]
+  -r, --run            Runs NW.js for the current platform                          [default: false]
+  -o, --buildDir       The build folder                                         [default: "./build"]
+  -f, --forceDownload  Force download of NW.js                                      [default: false]
   --cacheDir           The cache folder
-  --quiet              Disables logging                                                      [default: false]
+  --quiet              Disables logging                                             [default: false]
+  -- <args>            Pass custom arguments to the NW.js instance
+                       (-r, --run mode only)
+```
+
+To run NW.js in dev mode:
 
 ```
-#### Run NW.js
-During development you can run NW.js with `nwbuild -r path/to/your/younwapp/`
+nwbuild -r path/to/app -- <args>
+```
 
-## Module Usage
+### Module
 
 ```js
 var NwBuilder = require('nw-builder');
 var nw = new NwBuilder({
     files: './path/to/nwfiles/**/**', // use the glob format
-    platforms: ['osx64', 'win32', 'win64'],
-    version: '0.14.6'
+    platforms: ['osx64', 'win32', 'win64', 'linux32', 'linux64'],
+    version: 'latest',
+    argv: ['<nwjs_arg>', ... ] // see nwjs docs for possible <nwjs_arg> values
 });
 
 // Log stuff you want
@@ -59,51 +86,52 @@ nw.build().then(function () {
 });
 ```
 
-During development you can run NW.js with `run`:
+To run NW.js in dev mode:
 
 ```js
-nw.run().then(function () {
-   console.log('all done!');
-}).catch(function (error) {
+nw.run()
+  .then(function () {
+    console.log("all done!");
+  })
+  .catch(function (error) {
     console.error(error);
-});
+  });
 ```
 
-`build` and `run` also supports callbacks:
+## API Reference
 
-```js
-nw.build(function(err) {
-    if(err) return console.error(err);
-    console.log('all done!');
-});
-```
+> Stay up to date via the [Changelog](https://github.com/nwjs-community/nw-builder/blob/master/.github/CHANGELOG.md).
 
 ### Options
 
-#### options.files *Required*
-Type: `String`  
-Default value: `null`  
+#### options.files _Required_
 
-The path to your node webkit app. It supports [simple-glob](https://github.com/jedmao/simple-glob) so you can do stuff like `['foo/*.js', '!foo/bar.js', 'foo/bar.js']`.
+Type: `String`
+Default value: `null`
 
+The path to your node webkit app. It supports [simple-glob](https://github.com/jedmao/simple-glob) so you can do stuff like `['foo/*.js', '!foo/bar.js', 'foo/bar.js']`.
 
 #### options.version
-Type: `String`  
-Default value: `'latest'`  
 
-The version of NW.js you want to use. Per default it looks up the latest version. [Here is a list](https://github.com/nwjs/nw.js/wiki/Downloads-of-old-versions) of all available releases
+Type: `String`
+Default value: `'latest'`
+
+The version of NW.js you want to use. Per default it looks up the latest version. [Here is a list](https://github.com/nwjs/nw.js/tags) of all available releases.
 
 #### options.flavor
-Type: `String`  
-Default value: `'sdk'`  
+
+Type: `String`
+Default value: `'sdk'`
 
 The flavor of NW.js you want to use. Per default it will be `sdk`. [Here is a list](https://github.com/nwjs/nw.js/wiki/Build-Flavors) of all flavor available.
 
 The value `sdk` is most used for development whereas `normal` for production.
 
 #### options.platforms
-Type: `Array`  
-Default value: `['osx64', 'win32', 'win64']`  
+
+Type `(CLI)`: `String` (comma separated values)
+Type `(API)`: `Array` of `String`
+Default value: [`<current OS>`]
 
 The platforms you want to build. Can be `['win32', 'win64', 'osx32', 'osx64', 'linux32', 'linux64']`
 
@@ -112,80 +140,99 @@ The values `['win', 'osx', 'linux']` can also be used and will build both the 32
 Be aware that the osx32 version can only be built with legacy version of nwjs. Since > 0.12.0, only 64 bits for osx works.
 
 #### options.appName
-Type: `String`  
-Default value: `false`  
+
+Type: `String`
+Default value: `false`
 
 The Name of your NW.js app. If this value is set to null, it will autodetect the `name` from your projects package.json. This will be used to generate a plist file for mac.
 
 #### options.appVersion
-Type: `String`  
-Default value: `false`  
+
+Type: `String`
+Default value: `false`
 
 The version of your NW.js app. If this value is set to null, it will autodetect the `version` form your projects package.json. This will be used to generate a plist file for mac.
 
 #### options.buildDir
-Type: `String`  
-Default value: `./build`  
+
+Type: `String`
+Default value: `./build`
 
 This is where the releases are saved.
 
 #### options.cacheDir
-Type: `String`  
-Default value: `./cache`  
 
-This is where the cached NW.js downloads are
+Type: `String`
+Default value: `./cache`
+
+This is where the cached NW.js downloads are.
 
 #### options.buildType
+
 Type: `String` or `function`
-Default value: `default`  
+Default value: `default`
 
 How you want to save your build.
 
-* `default` [appName]
-* `versioned` [appName] -v[appVersion]
-* `timestamped` [appName] - [timestamp];
-* A function with options as scope (e.g `function () {return this.appVersion;}` )
+- `default` [appName]
+- `versioned` [appName] -v[appVersion]
+- `timestamped` [appName] - [timestamp];
+- A function with options as scope (e.g `function () {return this.appVersion;}` )
 
 #### options.forceDownload
-Type: `Boolean`  
-Default value: `false`  
 
-This will delete everything in your `build_dir` directory, including the cached downloaded prebuilt binaries
+Type: `Boolean`
+Default value: `false`
+
+This will delete everything in your `build_dir` directory, including the cached downloaded prebuilt binaries.
+
+#### options.argv
+
+Type `(CLI)`: `String` (comma separated values)
+Type `(API)`: `Array` of `String`
+Default Value: []
+
+Pass Command Line Options when you run an NW.js instance. Ignored in case of build.
 
 #### options.macCredits
-Type: `String`  
-Default value: `false`  
+
+Type: `String`
+Default value: `false`
 
 MAC ONLY: The path to your credits.html file. If your don't provide your own it will use the one provided by NW.js
 
 #### options.macIcns
-Type: `String`  
-Default value: `false`  
+
+Type: `String`
+Default value: `false`
 
 MAC ONLY: The path to your ICNS icon file. If your don't provide your own it will use the one provided by NW.js
 
 #### options.zip
-Type: `Boolean`  
-Default value: `null`  
+
+Type: `Boolean`
+Default value: `null`
 
 WINDOW ONLY: Instead of zipping the application and merging it into the executable the application content is placed next to the application (which speed up the startup time for large apps). The default behaviour is platform specific. For `windows` and `linux`, the application is zipped and merged into the executable. For `mac`, the application is not zipped.
 
 #### options.zipOptions
-Type: `Object`  
-Default value: `null`  
+
+Type: `Object`
+Default value: `null`
 
 Allows to configure the underling zip library parameters, like store or compression ratio.
 
 See [archiver](http://archiverjs.com/docs/global.html#ZipOptions) documentation for detailed description of properties.
 
 #### options.macPlist
-Type: `String` or `Object`  
-Default value: `false`  
 
-MAC ONLY: Pass a string containing the path to your own plist file. If a string isn't passed, a plist file will be generated from your package.json. Pass an object to overwrite or add properties to the generated plist file.
+Type: `String` or `Object`
+Default value: `false`
 
+MAC ONLY: Pass a string containing the path to your own plist file. If a string isn't passed, a plist file will be generated from your package.json. Pass an object to overwrite or add properties to the generated plist file.
 
 #### options.winVersionString
+
 Type: `Object`
 Default value: `{}`
 
@@ -203,17 +250,26 @@ winVersionString: {
 ```
 
 #### options.winIco
-Type: `String`  
-Default value: `null`  
+
+Type: `String`
+Default value: `null`
 
 WINDOWS ONLY: The path to your ICO icon file. If your don't provide your own it will use the one provided by NW.js. If you are building on MAC or LINUX you must have [Wine](https://www.winehq.org/) installed to use this option.
 
 #### options.macZip (DEPRECATED)
-Type: `Boolean`  
-Default value: `null`  
+
+Type: `Boolean`
+Default value: `null`
 
 MAC ONLY: Use a `app.nw` folder instead of `ZIP` file, this significantly improves the startup speed of applications on `mac`, since no decompressing is needed. Builds on other platforms will still use `ZIP` files. The default behaviour of node-webkit-builder is to not use `ZIP` files on the `mac` platform. In case of the `mac` platform the option `macZip` can override the option `zip`.
 
+#### options.mergeZip
+
+Type: `Boolean`
+Default value: `true`
+
+WINDOWS AND LINUX ONLY: Merge the source file package with the Node Webkit executable.
+
 ### Manifest Options
 
 #### platformOverrides
@@ -274,13 +330,13 @@ For example, when building for Windows, the manifest generated and put into the
 
 ```json
 {
-    "name": "nw-demo",
-    "version": "0.1.0",
-    "main": "index.html",
-    "window": {
-        "frame": true,
-        "toolbar": false
-    }
+  "name": "nw-demo",
+  "version": "0.1.0",
+  "main": "index.html",
+  "window": {
+    "frame": true,
+    "toolbar": false
+  }
 }
 ```
 
@@ -298,35 +354,35 @@ To get around it, run `ulimit -n 1024` (or add it to your `~/.bash_profile`). Fo
 
 ## Team
 
-**Current**
-
-- Adam Lynch ([@adam-lynch](https://github.com/adam-lynch))
-- Rémy Boulanouar ([@DblK](https://github.com/DblK))
-- You? :smile:. We're open to contributions (to the code, documentation, or anything else) and or additional maintainers.
-
-**Past**
-
-- Steffen Müller ([@steffenmllr](https://github.com/steffenmllr)) (Creator)
-- Gabe Paez ([@gabepaez](https://github.com/gabepaez))
-- Andy Trevorah ([@trevorah](https://github.com/trevorah))
+This project was created by [Steffen Müller](https://github.com/steffenmllr) and has been maintained by [Gabe Paez](https://github.com/gabepaez), [Andy Trevorah](https://github.com/trevorah), [Adam Lynch](https://github.com/adam-lynch) and [Rémy Boulanouar](https://github.com/DblK) in the past. This project is currently maintained by [Ayushman Chhabra](https://github.com/ayushmxn).
 
 ## Contributing
 
-See [CONTRIBUTING.md](CONTRIBUTING.md).
-
-## Release History
-
-See [CHANGELOG.md](CHANGELOG.md) or [Releases](https://github.com/nwjs-community/nw-builder/blob/develop/releases).
+### Getting Started
+
+1. Pick and install a Node version manager
+   * Linux/OSX - [nvm](https://github.com/nvm-sh/nvm)
+   * Windows 8+ - [nvm-windows](https://github.com/coreybutler/nvm-windows)
+   * Windows 7 - [nodist](https://github.com/nullivex/nodist)
+   * Win/Lin/OSX - [volta](https://volta.sh)
+1. Use your version manager to install Node 14.19, 16.9, 18.2 or above
+1. Run `corepack enable`
+1. `corepack prepare pnpm@7.1.7 --activate`
+1. `pnpm install`
+   * If you haven't used `pnpm` before, [here is a cheatsheet](https://dev.to/equiman/npm-vs-yarn-vs-pnpm-commands-cheatsheet-3el8)
+1. `pnpm demo` to test your changes at first glance
+1. `pnpm test` to run unit tests
+1. Don't forget to run `pnpm format && pnpm lint` before commiting your changes
+
+### General Guidelines
+
+- Whenever possible, open an issue before submitting a pull request.
+- PRs should have short descriptive titles. For example:
+  - fix(docs): fix typo in `options.platform` description
+  - feat(platform): add support for mac m1
+- Ideally, a PR should reference a related issue
+- Ensure there are tests that cover your changes
 
 ## License
 
-[MIT License](https://en.wikipedia.org/wiki/MIT_License)
-
-[npm-url]: https://www.npmjs.com/package/nw-builder
-[npm-image]: https://img.shields.io/npm/v/nw-builder.svg?style=flat
-
-[travis-url]: https://travis-ci.org/nwjs/nw-builder
-[travis-image]: https://img.shields.io/travis/nwjs/nw-builder/master.svg?style=flat
-
-[depstat-url]: https://david-dm.org/nwjs/nw-builder
-[depstat-image]: https://david-dm.org/nwjs/nw-builder.svg?style=flat
+[MIT](https://github.com/nwutils/nw-builder/blob/master/.github/LICENSE)

package/bin/nwbuild.cjs

@@ -0,0 +1,97 @@
+#!/usr/bin/env node
+const NwBuilder = require("../lib/index.cjs");
+const path = require("path");
+const { detectCurrentPlatform } = require("../dist/index.cjs");
+
+const currentPlatform = detectCurrentPlatform(process);
+
+const argv = require("yargs")
+  .command("$0 <path>")
+  .usage("Usage:\n  $0 [options] [path] [-- <args>]")
+
+  .alias("p", "platforms")
+  .default("p", currentPlatform)
+  .describe(
+    "p",
+    "Platforms to build, comma-sperated, can be: \n  win32, win64, osx32, osx64, linux32, linux64 or \nwin, osx, linux",
+  )
+
+  .version(false)
+  .alias("v", "version")
+  .default("v", "latest")
+  .describe("v", "The NW.js version, eg. 0.8.4")
+
+  .alias("r", "run")
+  .default("r", false)
+  .describe("r", "Runs NW.js for the current platform")
+  .boolean("r")
+
+  .alias("o", "buildDir")
+  .default("o", "./build")
+  .describe("o", "The build folder")
+
+  .alias("f", "forceDownload")
+  .default("f", false)
+  .describe("f", "Force download of NW.js")
+  .boolean("f")
+
+  .alias("n", "name")
+  .describe("n", "The Name of your NW.js app.")
+
+  .describe("cacheDir", "The cache folder")
+
+  .default("quiet", false)
+  .describe("quiet", "Disables logging")
+  .boolean("quiet")
+
+  .describe(
+    " <args>",
+    "Pass custom arguments to the NW.js instance \n(-r, --run mode only)",
+  )
+
+  // Howto Help
+  .help("h")
+  .alias("h", "help")
+
+  .wrap(100).argv;
+
+const options = {
+  appName: argv.name,
+  files: path.resolve(process.cwd(), argv.path) + "/**/*",
+  flavor: argv.flavor || "sdk",
+  platforms: argv.platforms ? argv.platforms.split(",") : [currentPlatform],
+  currentPlatform: currentPlatform,
+  version: argv.version,
+  macIcns: argv.macIcns || false,
+  winIco: argv.winIco || false,
+  cacheDir: argv.cacheDir
+    ? path.resolve(process.cwd(), argv.cacheDir)
+    : path.resolve(__dirname, "..", "cache"),
+  buildDir: path.resolve(process.cwd(), argv.buildDir),
+  forceDownload: argv.forceDownload,
+  // get all argv arguments after --
+  argv: process.argv.slice(
+    process.argv.findIndex(function firstDash(el) {
+      return el === "--";
+    }) + 1,
+  ),
+};
+
+// Initialize Builder
+const nw = new NwBuilder(options);
+
+// Logging
+if (!(argv.quiet || argv.quite)) {
+  nw.on("log", console.log);
+}
+
+// Build or Run the app
+const np = argv.r ? nw.run() : nw.build();
+np.then(function () {
+  process.exit(0);
+}).catch(function (error) {
+  if (error) {
+    console.error(error);
+    process.exit(1);
+  }
+});

package/dist/index.cjs

@@ -0,0 +1 @@
+var d=Object.create;var a=Object.defineProperty;var h=Object.getOwnPropertyDescriptor;var p=Object.getOwnPropertyNames;var I=Object.getPrototypeOf,S=Object.prototype.hasOwnProperty;var s=(r,t)=>{for(var e in t)a(r,e,{get:t[e],enumerable:!0})},u=(r,t,e,f)=>{if(t&&typeof t=="object"||typeof t=="function")for(let n of p(t))!S.call(r,n)&&n!==e&&a(r,n,{get:()=>t[n],enumerable:!(f=h(t,n))||f.enumerable});return r};var l=(r,t,e)=>(e=r!=null?d(I(r)):{},u(t||!r||!r.__esModule?a(e,"default",{value:r,enumerable:!0}):e,r)),C=r=>u(a({},"__esModule",{value:!0}),r);var O={};s(O,{Platform:()=>o,checkCache:()=>c,detectCurrentPlatform:()=>i});module.exports=C(O);var x={NIX_32:"linux32",NIX_64:"linux64",OSX_32:"osx32",OSX_64:"osx64",WIN_32:"win32",WIN_64:"win64"};Object.freeze(x);var o=x;var m=l(require("fs"),1),_=l(require("path"),1),N=(r,t)=>{let e=!1;if(t.length===1&&t[0]==="*")return m.default.existsSync(r)&&m.default.readdirSync(r).length>=2;for(let f of t){if(e)return!1;m.default.existsSync(_.default.join(r,f))||(e=!0)}return!e},c=N;var X=r=>{switch(r.platform){case"darwin":return r.arch==="x64"?o.OSX_64:o.OSX_32;case"win32":return r.arch==="x64"||r.env.PROCESSOR_ARCHITEW6432?o.WIN_64:o.WIN_32;case"linux":return r.arch==="x64"?o.NIX_64:o.NIX_32;default:return}},i=X;0&&(module.exports={Platform,checkCache,detectCurrentPlatform});

package/lib/Version.cjs

@@ -0,0 +1,81 @@
+var platforms = require("./platforms.cjs");
+var _ = require("lodash");
+var semver = require("semver");
+
+/**
+ * Represents a version.
+ * @constructor
+ * @param {string} args.version.
+ * @param {string} args.flavors.
+ * @param {array} args.supportedPlatforms - array of strings like `osx64`.
+ * @param {string} args.downloadUrl.
+ */
+module.exports = function Version(args) {
+  var generatePlatformUrls,
+    result = {
+      isLegacy: semver.lt(args.version, "0.12.3"),
+      name:
+        semver.gte(args.version, "0.12.0") ||
+        semver.satisfies(args.version, "~0.12.0-alpha")
+          ? "nwjs"
+          : "node-webkit",
+      version: args.version,
+    };
+
+  // 0.12.3 is an exception that is in the manifest but is pretty much a legacy version
+  if (result.isLegacy || args.version === "0.12.3") {
+    generatePlatformUrls = function (version, flavors, supportedPlatforms) {
+      var platformUrls = {};
+      supportedPlatforms.forEach(function (supportedPlatform) {
+        flavors.forEach(function (flavor) {
+          platformUrls[supportedPlatform + "-" + flavor] =
+            args.downloadUrl +
+            _.template(platforms[supportedPlatform].versionNameTemplate)(
+              result,
+            );
+        });
+      });
+      return platformUrls;
+    };
+  } else {
+    var fixPlatformName = function (platform) {
+      return platform.replace("32", "-ia32").replace("64", "-x64");
+    };
+
+    var mapPlatformToExtension = function (platform) {
+      if (platform.indexOf("linux") === 0) {
+        return "tar.gz";
+      }
+
+      return "zip";
+    };
+
+    generatePlatformUrls = function (version, flavors, supportedPlatforms) {
+      var platformUrls = {};
+      supportedPlatforms.forEach(function (platform) {
+        flavors.forEach(function (flavor) {
+          platformUrls[platform + "-" + flavor] =
+            args.downloadUrl +
+            "v" +
+            version +
+            "/nwjs" +
+            (flavor === "normal" ? "" : "-" + flavor) +
+            "-v" +
+            version +
+            "-" +
+            fixPlatformName(platform) +
+            "." +
+            mapPlatformToExtension(platform);
+        });
+      });
+      return platformUrls;
+    };
+  }
+
+  result.platforms = generatePlatformUrls(
+    args.version,
+    args.flavors,
+    args.supportedPlatforms,
+  );
+  return result;
+};