nw-builder 3.5.4 → 3.6.0

package/{CHANGELOG.md → .github/CHANGELOG.md}

@@ -5,13 +5,36 @@ All notable changes to this project will be documented in this file and in the [
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [Unreleased]
+
+## [3.6.0] - 2022-05-18
+### Added
+- GitHub Actions for CICD [#552](https://github.com/nwjs-community/nw-builder/pull/552)
+- Support multiple locales on OSX [#389](https://github.com/nwjs-community/nw-builder/pull/389)
+- Pull request and issue template [#553](https://github.com/nwjs-community/nw-builder/pull/553)
+### Changed
+- Dependencies [#550](https://github.com/nwjs-community/nw-builder/pull/550)
+- Documentation [#540](https://github.com/nwjs-community/nw-builder/pull/540) [#553](https://github.com/nwjs-community/nw-builder/pull/553) [#555](https://github.com/nwjs-community/nw-builder/pull/555)
+- Improve run mode by detecting current platform to prevent downloading additional binaries
+### Removed
+- Travis
+- AppVeyor
+- JSHint
+- EditorConfig
+
+## [3.5.7]
+
+### Security
+
+- Source platform overrides module into the project instead of it being an extenal dependency. This helped us get rid of a vulnerable lodash version. See https://github.com/nwjs-community/nw-builder/issues/500
+
 ## [3.5.1] - 2017-10-19
 
-## Added
+### Added
 
 - Add option.winVersionString for accurate process name. See https://github.com/nwjs-community/nw-builder/pull/459.
 
-## Fixed
+### Fixed
 
 - Small platform overrides fix. See https://github.com/nwjs-community/nw-builder/pull/477/files.
 
@@ -47,7 +70,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ## Old format
 
 - 2017-05-22    `3.2.3` Fix for caching when a version is specified (thanks @piwonesien for the help).
-- 2017-05-20    `3.2.2` Fix: when using the `nwbuild` in run mode, the `-p` option was ignored and the current platform was always used. 
+- 2017-05-20    `3.2.2` Fix: when using the `nwbuild` in run mode, the `-p` option was ignored and the current platform was always used.
 - 2017-05-16    `3.2.1` Fix: NW.js 0.22.0+ apps didn't open.
 - 2017-02-12    `3.2.0` Defaults to HTTPS now, added `manifestUrl` option, and bumped some dependencies.
 - 2016-10-09    `3.1.2` Fix for passing array as files option when running app (plus some security fixes).
@@ -80,4 +103,3 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - 2014-07-31    `0.0.4` fixed compatibility with nodewebkit 0.10.0
 - 2014-04-20    Added run option, bug fixes
 - 2014-04-13    Preview Release
-

package/.github/ISSUE_REQUEST_TEMPLATE.md

@@ -0,0 +1,16 @@
+### Issue Type
+
+- [ ] Bug Fix
+- [ ] Feature
+- [ ] Other
+
+### Current/Missing Behaviour
+
+### Expected/Proposed Behaviour
+
+### Additional Info
+
+- Operating System:
+- Node version:
+- NW.js version:
+- ...

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,5 @@
+Fixes: #
+
+### Changes
+
+- ...

package/.github/workflows/cd.yml

@@ -0,0 +1,24 @@
+name: cd
+on:
+  push:
+    branches:
+    - master
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: pnpm/action-setup@v2.2.1
+        with:
+          version: 7.1.0
+          run_install: true
+
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '16'
+
+      - run: pnpm install
+      - uses: JS-DevTools/npm-publish@v1
+        with:
+          token: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/ci.yml

@@ -0,0 +1,27 @@
+name: ci
+on:
+  pull_request:
+    branches:
+    - master
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node: [14, 16]
+    steps:
+      - uses: actions/checkout@v3
+      - uses: pnpm/action-setup@v2.2.1
+        with:
+          version: 7.1.0
+          run_install: true
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node }}
+
+      - run: pnpm install
+      - run: pnpm format
+      # - run: pnpm lint
+      - run: pnpm test

package/README.md

@@ -1,52 +1,66 @@
-# nw-builder [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-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.
 
+## Installation
 
-### Installation
+Using npm:
+```javascript
+npm install nw-builder
+```
 
-##### Local
-```shell
-npm install nw-builder --save-dev
+Using yarn:
+```javascript
+yarn add nw-builder
 ```
 
-##### Global
-```shell
-npm install nw-builder -g
+Using pnpm:
+```javascript
+pnpm 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 :)
 
+## 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:
+```
+nwbuild -r path/to/app -- <args>
 ```
-#### Run NW.js
-During development you can run NW.js with `nwbuild -r path/to/your/younwapp/`
 
-## 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,8 +73,7 @@ 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!');
@@ -69,41 +82,37 @@ nw.run().then(function () {
 });
 ```
 
-`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`  
+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'`  
+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
+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,32 +121,32 @@ 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`  
+Type: `String`
+Default value: `./cache`
 
-This is where the cached NW.js downloads are
+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.
 
@@ -147,40 +156,47 @@ How you want to save your build.
 * A function with options as scope (e.g `function () {return this.appVersion;}` )
 
 #### options.forceDownload
-Type: `Boolean`  
-Default value: `false`  
+Type: `Boolean`
+Default value: `false`
+
+This will delete everything in your `build_dir` directory, including the cached downloaded prebuilt binaries.
 
-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`  
+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.
 
@@ -203,14 +219,14 @@ 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`.
 
@@ -298,35 +314,17 @@ 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).
+- 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

package/bin/nwbuild

@@ -5,15 +5,18 @@ var NwBuilder = require('./../lib');
 var path = require('path');
 var detectCurrentPlatform = require('../lib/detectCurrentPlatform.js');
 
+var currentPlatform = detectCurrentPlatform();
+
 var argv = optimist
-    .usage('Usage: nwbuild [options] [path]')
+    .usage('Usage:\n  nwbuild [options] [path] [-- <args>]')
 
     .alias('p', 'platforms')
-    .describe('p', 'Platforms to build, comma-sperated, can be: win32,win64,osx32,osx64,linux32,linux64')
+    .default('p', currentPlatform)
+    .describe('p', 'Platforms to build, comma-sperated, can be: \n  win32, win64, osx32, osx64, linux32, linux64 or \nwin, osx, linux')
 
     .alias('v', 'version')
     .default('v', 'latest')
-    .describe('v', 'The nw version, eg. 0.8.4')
+    .describe('v', 'The NW.js version, eg. 0.8.4')
 
     .alias('r', 'run')
     .default('r', false)
@@ -38,6 +41,10 @@ var argv = optimist
     .describe('quiet', 'Disables logging')
     .boolean('quiet')
 
+    .describe(' <args>', 'Pass custom arguments to the NW.js instance \n(-r, --run mode only)')
+
+    .wrap(100)
+
     .argv;
 
 // Howto Help
@@ -57,31 +64,21 @@ var options = {
     appName: argv.name,
     files: path.resolve(process.cwd(), files) + '/**/*',
     flavor: argv.flavor || 'sdk',
-    platforms: argv.platforms ? argv.platforms.split(',') : null,
+    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
+    forceDownload: argv.forceDownload,
+    // get all argv arguments after --
+    argv: process.argv.slice(process.argv.findIndex(function firstDash(el) {
+        return el === '--'
+    }) + 1)
 };
 
-// If we are in run mode
-if(argv.r) {
-    var currentPlatform = detectCurrentPlatform();
-    if(!options.platforms){
-        options.platforms = [ currentPlatform ];
-    }
-    options.currentPlatform = currentPlatform;
-}
-
-// Set default target platforms here
-// Remove osx32 from default, nwjs didn't support osx32 yet
-if (!options.platforms) {
-    options.platforms = ['osx64', 'win32', 'win64']
-}
-
-// Build App
+// Initialize Builder
 var nw = new NwBuilder(options);
 
 // Logging
@@ -89,7 +86,7 @@ if(!(argv.quiet || argv.quite)) {
     nw.on('log',  console.log);
 }
 
-// Build or run the app
+// Build or Run the app
 var np = (argv.r ? nw.run() : nw.build());
 np.then(function() {
     process.exit(0);

package/demo.js

@@ -0,0 +1,22 @@
+const NwBuilder = require('./lib');
+const detectCurrentPlatform = require('./lib/detectCurrentPlatform');
+
+const nw = new NwBuilder({
+    version: '0.64.1',
+    files: './example/nwapp/**',
+    macIcns: './icons/icon.icns',
+    macPlist: {mac_bundle_id: 'myPkg'},
+    platforms: [
+        detectCurrentPlatform(),
+        // 'linux64',
+        // 'osx64',
+        // 'win64',
+    ]
+});
+
+
+nw.on('log', (msg) => console.log('nw-builder', msg));
+
+nw.run()
+    .then(() => process.exit(0))
+    .catch((error) => console.log(error))

package/example/icons/README.md

@@ -0,0 +1,7 @@
+This directory contains app icons passed to nw-builder.
+
+---
+
+## See something which could be improved?
+
+Great, see [CONTRIBUTING.md](../../CONTRIBUTING.md).

package/example/nwapp/Credits.html

@@ -0,0 +1,9 @@
+<style type="text/css">
+  html,body,.body {
+    overflow: hidden;
+  }
+</style>
+<div class="body">
+  <h1>me, myself and i.</h1>
+  <p>much has been done.</p>
+</div>

package/example/nwapp/README.md

@@ -0,0 +1,7 @@
+This directory contains the actual example app code.
+
+---
+
+## See something which could be improved?
+
+Great, see [CONTRIBUTING.md](../../CONTRIBUTING.md).

package/example/nwapp/images/README.md

@@ -0,0 +1,7 @@
+Any images used within the example app are stored in this directory.
+
+---
+
+## See something which could be improved?
+
+Great, see [CONTRIBUTING.md](../../CONTRIBUTING.md).

package/example/nwapp/index.html

@@ -0,0 +1,22 @@
+<!DOCTYPE html>
+<html>
+<head>
+<title>Hello World from nw-builder!</title>
+</head>
+<body>
+<h1>Hello World!</h1>
+We are using node.js <script>document.write(process.version)</script>
+
+<h2>Here is a required node_module</h2>
+<ul>
+<script>
+for (var counter=0; counter<xs.length; counter++) {
+   document.write("<li>" + counter + "</li>");
+}
+</script>
+</ul>
+
+<h2>And here is a cute kitten:</h2>
+<img src="images/kitten.jpg">
+</body>
+</html>

package/example/nwapp/package.json

@@ -0,0 +1,23 @@
+{
+  "main": "index.html",
+  "name": "nw-demo",
+  "description": "demo app of NW.js",
+  "version": "0.1.0",
+  "keywords": [ "demo", "NW.js" ],
+  "window": {
+    "title": "NW.js demo",
+    "icon": "link.png",
+    "toolbar": false,
+    "frame": true,
+    "width": 800,
+    "height": 500,
+    "position": "center",
+    "min_width": 400,
+    "min_height": 200,
+    "max_width": 800,
+    "max_height": 600
+  },
+  "webkit": {
+    "plugin": true
+  }
+}

package/example/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "example",
+  "private": true,
+  "scripts": {
+    "start": "node index.js"
+  }
+}