nw-builder 4.0.2 → 4.0.3

package/src/util/validate.js

@@ -0,0 +1,30 @@
+import { readdir } from "node:fs/promises";
+
+/**
+ * Validate options
+ *
+ * @param  {object}    options      Options
+ * @param  {object}    releaseInfo  Version specific NW release info
+ * @return {undefined}              True if options are valid. False otherwise
+ */
+export const validate = async (options, releaseInfo) => {
+  if (options.srcDir === "") {
+    throw new Error("srcDir is empty");
+  }
+  if (options.mode !== "run" && options.mode !== "build") {
+    throw new Error("Invalid mode value. Expected run or build.");
+  }
+  if (
+    options.platform &&
+    options.arch &&
+    !releaseInfo.files.includes(`${options.platform}-${options.arch}`)
+  ) {
+    throw new Error(
+      `Platform ${options.platform} and architecture ${options.arch} is not supported. Sorry!`,
+    );
+  }
+  if (options.outDir) {
+    await readdir(options.outDir);
+  }
+  return undefined;
+};

package/test/{demo/bld.cjs → e2e/bld.js}

@@ -1,30 +1,38 @@
-const { nwbuild } = require("nw-builder");
+import { platform } from "node:process";
+import nwbuild from "nw-builder";
 
-const bld = async () => {
+if (platform === "linux") {
   await nwbuild({
     srcDir: "./nwapp",
+    mode: "build",
     version: "0.70.1",
     flavour: "normal",
     platform: "linux",
     arch: "x64",
     outDir: "./build/nix",
   });
+}
+
+if (platform === "darwin") {
   await nwbuild({
     srcDir: "./nwapp",
+    mode: "build",
     version: "0.70.1",
     flavour: "normal",
     platform: "osx",
     arch: "x64",
     outDir: "./build/osx",
   });
+}
+
+if (platform === "win32") {
   await nwbuild({
     srcDir: "./nwapp",
+    mode: "build",
     version: "0.70.1",
     flavour: "normal",
     platform: "win",
     arch: "x64",
     outDir: "./build/win",
   });
-};
-
-bld();
+}

package/test/e2e/nix.js

@@ -0,0 +1,11 @@
+import nwbuild from "nw-builder";
+
+await nwbuild({
+  srcDir: "./nwapp/**/*",
+  mode: "build",
+  version: "0.70.1",
+  flavour: "normal",
+  platform: "linux",
+  arch: "x64",
+  outDir: "./build/nix",
+});

package/test/e2e/nwapp/package.json

@@ -0,0 +1,6 @@
+{
+    "name": "nwdemo",
+    "version": "0.0.1",
+    "main": "index.html",
+    "author": "ABC Corp"
+}

package/test/e2e/osx.js

@@ -0,0 +1,11 @@
+import nwbuild from "nw-builder";
+
+await nwbuild({
+  srcDir: "./nwapp/**/*",
+  mode: "build",
+  version: "0.70.1",
+  flavour: "normal",
+  platform: "osx",
+  arch: "x64",
+  outDir: "./build/osx",
+});

package/test/e2e/win.js

@@ -0,0 +1,11 @@
+import nwbuild from "nw-builder";
+
+await nwbuild({
+  srcDir: "./nwapp/**/*",
+  mode: "build",
+  version: "0.70.1",
+  flavour: "normal",
+  platform: "win",
+  arch: "x64",
+  outDir: "./build/win",
+});

package/docs/index.md

@@ -1,112 +0,0 @@
-# Documentation
-
-> This assumes you know how to [write an NW.js application](https://nwjs.readthedocs.io/en/latest/For%20Users/Getting%20Started/).
-
-## Install
-
-Install `nw-builder` via `npm` or your preferred Node package manager of choice.
-
-```shell
-npm i -D nw-builder
-```
-
-## Usage
-
-### Run your first application
-
-Module usage
-
-```javascript
-import { nwbuild } from "nw-builder";
-
-nwbuild({
-  srcDir: "./nwapp",
-  mode: "run",
-  version: "0.70.1",
-  flavour: "sdk",
-});
-```
-
-CLI usage
-
-```shell
-nwbuild ./nwapp --mode=run --version=0.70.1 --flavour=sdk
-```
-
-package.json usage
-
-`./nwapp/package.json`
-
-```json
-{
-  "name": "nwdemo",
-  "main": "./index.html",
-  "nwbuild": {
-    "srcDir": "./nwapp",
-    "mode": "run",
-    "version": "0.70.1",
-    "flavour": "sdk"
-  }
-}
-```
-
-### Build your first application
-
-Module usage
-
-```javascript
-import { nwbuild } from "nw-builder";
-
-nwbuild({
-  srcDir: "./nwapp",
-  mode: "run",
-  version: "0.70.1",
-  flavour: "normal",
-  platform: "linux",
-  arch: "x64",
-  outDir: "./out",
-});
-```
-
-CLI usage
-
-```shell
-nwbuild ./nwapp --mode=build --version=0.70.1 --flavour=normal --platform=linux --arch=x64 --outDir=./out
-```
-
-package.json usage
-
-`./nwapp/package.json`
-
-```json
-{
-  "name": "nwdemo",
-  "main": "./index.html",
-  "nwbuild": {
-    "srcDir": "./nwapp",
-    "mode": "build",
-    "version": "0.70.1",
-    "flavour": "normal",
-    "platform": "linux",
-    "arch": "x64",
-    "outDir": "./out"
-  }
-}
-```
-
-## API Reference
-
-| Name        | Type      | Default                    | Description                                                                    |
-| ----------- | --------- | -------------------------- | ------------------------------------------------------------------------------ | -------------------------------------------------------------------- | ---------------------- |
-| srcDir      | `string   | string[]`                  |                                                                                | Directory to hold NW app files unless or array of file glob patterns |
-| mode        | `run      | build`                     |                                                                                | Run or build application                                             |
-| version     | `latest   | stable                     | string`                                                                        |                                                                      | NW runtime version     |
-| flavour     | `sdk      | normal`                    |                                                                                | NW runtime build flavour.                                            |
-| platform    | `linux    | osx                        | win`                                                                           |                                                                      | NW supported platforms |
-| arch        | `ia32     | x64`                       |                                                                                | NW supported architectures                                           |
-| outDir      | `string`  |                            | Directory to store build artifacts                                             |
-| cacheDir    | `string`  | `./cacheDir`               | Directory to store NW binaries                                                 |
-| downloadUrl | `string`  | `https://dl.nwjs.io`       | URI to download NW binaries from                                               |
-| manifestUrl | `string`  | `https://nwjs.io/versions` | URI to download manifest from                                                  |
-| cache       | `boolean` | `true`                     | If `true` the existing cache is used. Otherwise it removes and redownloads it. |
-| zip         | `boolean` | `false`                    | If `true` the `outDir` directory is zipped                                     |