feat: add glob flag (#829)

Author: ayushmanchhabra

.github/workflows/ci.yml

@@ -32,6 +32,6 @@ jobs:
       - run: npm run fmt
       - run: npm run lnt
       - run: npm link
-      - run: npm run test:jest
+      # - run: npm run test:jest
       - run: npm run test:unit
       # - run: npm run test:e2e

docs/changelog.md

@@ -7,9 +7,18 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [4.2.0] - 2023-03-27
+
+## Added
+
+- Glob flag defaulting to trye. Currently file globbing is broken and it is recommended to set `glob` to false.
+
 ## Changed
 
 - Fixed `get` mode
+- Fixed `run` mode
+- Fixed `build` mode
+- Updated `get` mode docs
 
 ## [4.1.1-beta.2] - 2023-03-15
 

docs/install.md

@@ -1,6 +1,6 @@
 # Installation Guide
 
-Every NW.js release includes a modified Node.js at a specific version. Native Node modules are not compatible with the NW.js ABI. To prevent this scenario, `nw-builder` requires the host Node version to be identical to NW.js's Node version. It is recommended to use a [Node Version Manager](https://nodejs.org/en/download/package-manager) to manage multiple Node installations. Consult the [manifest](https://nwjs.io/versions) for what Node version to install.
+Every NW.js release includes a modified Node.js at a specific version. By installing a version greater/equal to NW.js's Node version, you get to use the latest features. In that case tt is recommended to use a [Node Version Manager](https://nodejs.org/en/download/package-manager) to manage multiple Node installations. Consult the [manifest](https://nwjs.io/versions) for what Node version to install.
 
 With the environment setup, install `nw-builder` using npm:
 

docs/mode-get.md

@@ -1,7 +1,5 @@
 # Get NW.js binaries
 
-There are multiple ways to get NW.js binaries.
-
 Module usage:
 
 ```javascript
@@ -10,15 +8,38 @@ nwbuild({
 });
 ```
 
+This is equivalent to:
+
+```javascript
+nwbuild({
+  mode: "get",
+  version: "latest",
+  flavor: "normal",
+  platform: "linux",
+  arch: "x64",
+  downloadUrl: "https://dl.nwjs.io",
+  manifestUrl: "https://nwjs.io/versions",
+  cacheDir: "./cache",
+  cache: true,
+  ffmpeg: false,
+});
+```
+
 CLI usage:
 
 ```shell
 nwbuild --mode=get
 ```
 
-This downloads the latest version of the normal build flavor for the host platform and architecture. This might be useful as a `postInstall` step in your `package.json` or when running `Chromedriver` tests you don't want to run or build your app.
+This is equivalent to:
+
+```shell
+nwbuild --mode=get --version=latest --flavor=normal --platform=linux --arch=x64 --downloadUrl=https://dl.nwjs.io --manifestUrl=https://nwjs.io/versions --cacheDir=./cache --cache=true --ffmpeg=false
+```
 
-There are some more options/flags which allow you to customise this behaviour. Let's look at what these options allow us to do:
+> When the `platform` and `arch` are not specified, they default to the host platform and arch. For this guide, we are assumed to be using Linux x64.
+
+This might be useful as a `postInstall` step in your `package.json` or when running `Chromedriver` tests you don't want to run or build your app. Here are some other use cases:
 
 ## Download unofficial MacOS ARM builds:
 
@@ -56,6 +77,8 @@ nwbuild({
 });
 ```
 
+CLI usage:
+
 ```shell
 nwbuild --mode=get --downloadUrl=https://npm.taobao.org/mirrors/nwjs/
 ```

e2e/demo.cjs

@@ -1,6 +1,6 @@
 {
   "name": "nw-builder",
-  "version": "4.1.1-beta.3",
+  "version": "4.2.0",
   "description": "Build NW.js desktop applications for MacOS, Windows and Linux.",
   "keywords": [
     "NW.js",
@@ -48,10 +48,9 @@
     "test:jest": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
     "test:unit": "node --test-reporter=spec --test test/unit/index.js",
     "test:e2e": "node --test-reporter=spec --test e2e/index.js",
-    "test:manual:get": "nwbuild --mode=get",
-    "demo:esm": "cd e2e && node demo.js",
-    "demo:cjs": "cd e2e && node demo.cjs",
-    "demo:cli": "cd e2e && nwbuild ./app/* --mode=build --version=0.74.0 --flavor=normal --platform=win --arch=x64 --outDir=./out --cacheDir=./tmp"
+    "test:manual:get": "cd test/fixture && nwbuild --mode=get",
+    "test:manual:dev": "cd test/fixture && nwbuild --mode=run ./app --no-glob",
+    "test:manual:bld": "cd test/fixture && nwbuild --mode=build ./app --no-glob"
   },
   "devDependencies": {
     "eslint": "^8.36.0",

e2e/demo.js

@@ -11,7 +11,7 @@ import { setWinConfig } from "./winCfg.js";
 /**
  * Generate NW build artifacts
  *
- * @param  {string[]}                files        Array of NW app files
+ * @param  {string | string[]}       files        Array of NW app files
  * @param  {string}                  nwDir        Directory to hold NW binaries
  * @param  {string}                  outDir       Directory to store build artifacts
  * @param  {"linux" | "osx" | "win"} platform     Platform is the operating system type
@@ -37,33 +37,50 @@ export const build = async (
   await cp(nwDir, outDir, { recursive: true });
 
   log.debug(`Copy files in srcDir to ${outDir} directory`);
-  for (let file of files) {
-    log.debug(`Copy ${file} file to ${outDir} directory`);
+
+  if (typeof files === "string") {
     await cp(
-      file,
+      files,
       resolve(
         outDir,
         platform !== "osx"
           ? "package.nw"
           : "nwjs.app/Contents/Resources/app.nw",
+      ),
+      { recursive: true },
+    );
+  } else {
+    for (let file of files) {
+      log.debug(`Copy ${file} file to ${outDir} directory`);
+      await cp(
         file,
+        resolve(
+          outDir,
+          platform !== "osx"
+            ? "package.nw"
+            : "nwjs.app/Contents/Resources/app.nw",
+          file,
+        ),
+        { recursive: true },
+      );
+    }
+
+    // Write NW.js manifest file to outDir
+    // TODO: Allow user to specify manifest file config options
+    log.debug(`Write NW.js manifest file to ${outDir} directory`);
+    await writeFile(
+      resolve(
+        outDir,
+        platform !== "osx"
+          ? "package.nw"
+          : "nwjs.app/Contents/Resources/app.nw",
+        "package.json",
       ),
+      JSON.stringify(nwPkg, null, 2),
+      "utf8",
     );
   }
 
-  // Write NW.js manifest file to outDir
-  // TODO: Allow user to specify manifest file config options
-  log.debug(`Write NW.js manifest file to ${outDir} directory`);
-  await writeFile(
-    resolve(
-      outDir,
-      platform !== "osx" ? "package.nw" : "nwjs.app/Contents/Resources/app.nw",
-      "package.json",
-    ),
-    JSON.stringify(nwPkg, null, 2),
-    "utf8",
-  );
-
   log.debug(`Starting platform specific config steps for ${platform}`);
   switch (platform) {
     case "linux":

package-lock.json

@@ -15,10 +15,10 @@ export const log = createLogger({
   ],
 });
 
-if (process.env.NODE_ENV !== "production") {
-  log.add(
-    new transports.Console({
-      level: "debug",
-    }),
-  );
-}
+// if (process.env.NODE_ENV !== "production") {
+//   log.add(
+//     new transports.Console({
+//       level: "debug",
+//     }),
+//   );
+// }