nw-builder 3.7.4 → 3.8.2

package/.github/CHANGELOG.md

@@ -7,6 +7,24 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [3.8.1] - 2022-07-18
+
+### Changed
+
+- Fix regex to match `package.json` _files_ only
+
+## [3.8.0] - 2022-07-11
+
+## Added
+
+- `mode` option which defaults to run
+- `nwbuild` function
+- `quiet` option to documentation
+
+## Changed
+
+- CLI options by matching them to the API
+
 ## [3.7.4] - 2022-06-06
 
 ## Removed

package/.github/dependabot.yml

@@ -0,0 +1,17 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "npm" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"
+      day: "friday"
+  - package-ecosystem: "github-actions" # See documentation for possible values
+    directory: ".github/" # Location of package manifests
+    schedule:
+      interval: "weekly"
+      day: "friday"

package/.github/workflows/cd.yml

@@ -9,16 +9,11 @@ jobs:
     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
+      - uses: actions/setup-node@v3
         with:
           node-version: "16"
 
-      - run: pnpm install
+      - run: npm ci
       - uses: JS-DevTools/npm-publish@v1
         with:
           token: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/ci.yml

@@ -12,20 +12,15 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        node: [14, 16, 18]
+        node-version: [14, 16, 18]
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v3
-      - uses: pnpm/action-setup@v2.2.1
+      - uses: volta-cli/action@v1
         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
+          node-version: ${{ matrix.node-version }}
+          npm-version: '8.5.0'
+      - run: npm ci
+      - run: npm run format
+      - run: npm run lint
+      - run: npm run test

package/README.md

@@ -42,68 +42,48 @@ pnpm add nw-builder
 ### CLI
 
 ```shell
-Usage:
-  nwbuild [options] [path] [-- <args>]
-
-Options:
-  -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]
-  -- <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>
+nwbuild ./path/to/app
 ```
 
 ### Module
 
 ```js
-var NwBuilder = require('nw-builder');
-var nw = new NwBuilder({
-    files: './path/to/nwfiles/**/**', // use the glob format
-    platforms: ['osx64', 'win32', 'win64', 'linux32', 'linux64'],
-    version: 'latest',
-    argv: ['<nwjs_arg>', ... ] // see nwjs docs for possible <nwjs_arg> values
-});
+const { nwbuild } = require("nw-builder");
 
-// Log stuff you want
-nw.on('log',  console.log);
-
-nw.build().then(function () {
-   console.log('all done!');
-}).catch(function (error) {
-    console.error(error);
+nwbuild({
+  files: "./path/to/app",
+  platforms: ["linux64", "win32"],
 });
 ```
 
-To run NW.js in dev mode:
-
-```js
-nw.run()
-  .then(function () {
-    console.log("all done!");
-  })
-  .catch(function (error) {
-    console.error(error);
-  });
-```
+> If no `mode` option is defined, it defaults to `run`. If no `platforms` option is defined, it defaults to the current platform.
 
 ## API Reference
 
 > Stay up to date via the [Changelog](https://github.com/nwjs-community/nw-builder/blob/master/.github/CHANGELOG.md).
 
+### Methods
+
+#### nwbuild(options, callbacks)
+
+The function that setups up, runs and builds your NW.js applications. The `callbacks` are for the `run` and `build` function that run inside the `nwbuild` function. The callbacks `callback[0]`, `callback[1]`, `callback[2]` correspond to the `.then`, `.catch` and `.finally` functions of the `run` or `build` promise.
+
 ### Options
 
+#### options.mode
+
+Type: `run` | `build`
+Default value: `run`
+
+Specify if you want to run or build your app.
+
+#### options.quiet
+
+Type: `String`
+Default value: `info`
+
+Choose your level of logging between error, warn, info, debug and off.
+
 #### options.files _Required_
 
 Type: `String`
@@ -144,7 +124,7 @@ Be aware that the osx32 version can only be built with legacy version of nwjs. S
 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.
+The Name of your NW.js app. If this value is set to null, it will autodetect the `name` from your project's package.json. This will be used to generate a plist file for mac.
 
 #### options.appVersion
 
@@ -361,18 +341,13 @@ This project was created by [Steffen Müller](https://github.com/steffenmllr) an
 ### 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
+   - Linux/OSX - [nvm](https://github.com/nvm-sh/nvm)
+   - Win 7+/Linux/OSX - [volta](https://volta.sh)
+1. Use your version manager to install Node 14.19 or above
+1. Run `npm install`
+1. `npm run demo` to test your changes at first glance
+1. `npm t` to run unit tests
+1. Don't forget to run `npm run format && npm run lint` before commiting your changes
 
 ### General Guidelines
 

package/bin/nwbuild.cjs

@@ -1,102 +1,146 @@
 #!/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 yargs = require("yargs/yargs");
+const { hideBin } = require("yargs/helpers");
 
-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",
-  )
+const { nwbuild } = require("../lib/index.cjs");
+const { Options, detectCurrentPlatform } = require("../dist/index.cjs");
 
+const cli = yargs(hideBin(process.argv))
   .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,
-  macCredits: argv.macCredits || false,
-  macPlist: argv.macPlist || false,
-  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),
-  buildType: argv.buildType || 'default',
-  forceDownload: argv.forceDownload,
-  // get all argv arguments after --
-  argv: process.argv.slice(
-    process.argv.findIndex(function firstDash(el) {
-      return el === "--";
-    }) + 1,
-  ),
-  zip: argv.zip || null,
-  zipOptions: argv.zipOptions || null
-};
-
-// 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);
-  }
+  .command("[file(glob)] [options]")
+  .option("mode", {
+    type: "string",
+    description: "Choose between run and build mode",
+    default: Options["mode"],
+  })
+  .option("quiet", {
+    type: "string",
+    description:
+      "Choose your level of logging between error, warn, info, debug and off",
+    default: Options["quiet"],
+  })
+  .option("version", {
+    type: "string",
+    description: "Version of NW.js you want to use.",
+    group: "Run API",
+    default: Options["version"],
+  })
+  .option("flavor", {
+    type: "string",
+    description:
+      "sdk is recommended for development and normal is recommended for production.",
+    group: "Run API",
+    default: Options["flavor"],
+  })
+  .option("cacheDir", {
+    type: "string",
+    description: "Path to NW.js cache",
+    group: "Run API",
+    default: Options["cacheDir"],
+  })
+  .option("platforms", {
+    type: "array",
+    description:
+      "Supported platforms are linux32, linux64, osx32, osx64, win32, win64",
+    group: "Run API",
+    default: detectCurrentPlatform(process),
+  })
+  .option("appName", {
+    type: "string",
+    description: "Name of your application",
+    group: "Build API",
+    default: Options["appName"],
+  })
+  .option("appVersion", {
+    type: "string",
+    description: "Version of your application",
+    group: "Build API",
+    default: Options["appVersion"],
+  })
+  .option("buildDir", {
+    type: "string",
+    description: "Path to NW.js build",
+    group: "Build API",
+    default: Options["buildDir"],
+  })
+  .option("buildType", {
+    type: "string",
+    description:
+      "default is appName, \nversioned is [appName] -v[appVersion], \ntimestamped is [appName] - [timestamp]",
+    group: "Build API",
+    default: Options["buildType"],
+  })
+  .option("forceDownload", {
+    type: "boolean",
+    description: "Delete all cache and builds and redownload them",
+    group: "Build API",
+    default: Options["forceDownload"],
+  })
+  .option("macCredits", {
+    type: "string",
+    description:
+      "The path to your credits.html file. By default it uses the one provided by NW.js",
+    group: "Build API",
+    default: Options["macCredits"],
+  })
+  .option("macIcns", {
+    type: "string",
+    description:
+      "The path to your ICNS file. By default it uses the one provided by NW.js",
+    group: "Build API",
+    default: Options["macIcns"],
+  })
+  .option("macPlist", {
+    type: "string",
+    description:
+      "The path to your Plist file. By default a Plist file is generated from the package.json",
+    group: "Build API",
+    default: Options["macPlist"],
+  })
+  .option("winVersionString", {
+    type: "object",
+    description: "Descriptors for Windows executable",
+    group: "Build API",
+    default: Options["winVersionString"],
+  })
+  .option("winIco", {
+    type: "string",
+    description:
+      "Path to your ICO file. By default it uses the one provided by NW.js",
+    group: "Build API",
+    default: Options["winIco"],
+  })
+  .option("useRcedit", {
+    type: "string",
+    description:
+      "If set to true, it allows you to set the Windows icon using rcedit instead of winresourcer",
+    group: "Build API",
+    default: Options["useRcedit"],
+  })
+  .option("zip", {
+    type: "boolean",
+    description: "Zip your NW.js application",
+    group: "Package API",
+    default: Options["zip"],
+  })
+  .option("zipOptions", {
+    type: "boolean",
+    description:
+      "Configure the underling zip library parameters, like store or compression ratio",
+    group: "Package API",
+    default: Options["zipOptions"],
+  })
+  .option("mergeZip", {
+    type: "boolean",
+    description: "Merge the source file package with the NW.js executable",
+    group: "Package API",
+    default: Options["mergeZip"],
+  })
+  .parse();
+
+nwbuild({
+  ...cli,
+  currentPlatform: detectCurrentPlatform(process),
+  files: cli._,
 });