nw-builder 3.8.6-beta.0 → 3.8.6-beta.2

package/.eslintignore

@@ -0,0 +1,6 @@
+node_modules
+
+cache
+build
+dist
+out

package/.github/dependabot.yml

@@ -1,17 +1,12 @@
-# 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
+  - package-ecosystem: "npm"
+    directory: "."
     schedule:
-      interval: "weekly"
-      day: "friday"
-  - package-ecosystem: "github-actions" # See documentation for possible values
-    directory: ".github/" # Location of package manifests
+      interval: "daily"
+    target-branch: "v3"
+  - package-ecosystem: "github-actions"
+    directory: ".github/"
     schedule:
-      interval: "weekly"
-      day: "friday"
+      interval: "daily"
+    target-branch: "v3"

package/.github/workflows/cd.yml

@@ -1,20 +1,29 @@
-name: cd
+name: v3-cd
 on:
   push:
     branches:
       - v3
 
 jobs:
-  publish:
-    runs-on: ubuntu-latest
+  npm:
+    runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - name: Checkout repository
+        uses: actions/checkout@v3.3.0
+      - name: Get Node version from Node manifest
+        run: |
+          echo "NODE_VER=$(jq -r '.engines.node' package.json | sed 's/v//' )" >> $GITHUB_ENV
+      - name: Setup Node
+        uses: actions/setup-node@v3.6.0
         with:
-          node-version: 18
-
-      - run: npm ci
-      - uses: JS-DevTools/npm-publish@v2
+          node-version: ${{ env.NODE_VER }}
+          cache: "npm"
+      - name: Enable corepack
+        run: corepack enable
+      - name: Install dependencies
+        run: npm ci
+      - name: Publish to npm
+        uses: JS-DevTools/npm-publish@v2.2.1
         with:
           token: ${{ secrets.NPM_TOKEN }}
           tag: stable

package/.github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: ci
+name: v3-ci
 on:
   pull_request:
     branches:
@@ -12,19 +12,28 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  test:
-    strategy:
-      matrix:
-        os: [ubuntu-latest, macos-latest, windows-latest]
-        node-version: [14, 16, 18]
-    runs-on: ${{ matrix.os }}
+  e2e:
+    runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v3
-      - uses: volta-cli/action@v1
+      - name: Checkout repository
+        uses: actions/checkout@v3.3.0
+      - name: Get Node version from Node manifest
+        run: |
+          echo "NODE_VER=$(jq -r '.engines.node' package.json | sed 's/v//' )" >> $GITHUB_ENV
+      - name: Setup Node
+        uses: actions/setup-node@v3.6.0
         with:
-          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
+          node-version: ${{ env.NODE_VER }}
+          cache: "npm"
+      - name: Enable corepack
+        run: corepack enable
+      - name: Install dependencies
+        run: npm ci
+      - name: Prepare test environment
+        run: npm run test:prep
+      - name: Run Jest tests
+        run: npm run test:jest
+      - name: Run Tape tests
+        run: npm run test:tape
+      - name: Run ChromeDriver tests
+        run: npm run test:sanity

package/.prettierignore

@@ -0,0 +1,6 @@
+node_modules
+
+cache
+build
+dist
+out

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

@@ -1,12 +1,26 @@
-# Change Log
+# Changelog
 
-All notable changes to this project will be documented in this file and in the [Releases](https://github.com/nwjs-community/nw-builder/blob/develop/releases) section.
+All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [3.8.6-beta.2] - 2023-08-23
+
+### Changed
+
+- Migrate from function to class implementation.
+- Refactor options parsing and validation logic.
+
+## [3.8.6-beta.1] - 2023-08-19
+
+### Changed
+
+- Migrate from `nw-install` to `node:https`.
+- Refactor executable renaming logic
+
 ## [3.8.6] - 2022-09-22
 
 - Fix mac and windows build

package/README.md

@@ -1,7 +1,12 @@
 # nw-builder
 
+[![npm](https://img.shields.io/npm/v/nw-builder/stable)](https://www.npmjs.com/package/nw-builder)
+[![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 [NW.js](https://github.com/nwjs/nw.js) applications for Mac, Windows and Linux.
 
+For version 4, please go to the [corresponding branch](https://github.com/nwutils/nw-builder/tree/main).
+
 ## Table of Contents
 
 - [Installation](https://github.com/nwutils/nw-builder#installation)
@@ -208,6 +213,34 @@ Default value: `true`
 
 WINDOWS AND LINUX ONLY: Merge the source file package with the Node Webkit executable.
 
+#### options.downloadUrl
+
+Type: `string`
+Default value: `https://dl.nwjs.io`
+
+Server to download binaries from.
+
+#### options.manifestUrl
+
+Type: `string`
+Default value: `https://nwjs.io/versions`
+
+Server to download binaries from.
+
+#### options.quiet
+
+Type: `string`
+Default: `"info"`
+
+Set the log level. Valid options are `"error"`, `"warn"`, `"info"`, `"debug"` and `"off"`.
+
+#### options.useRcedit
+
+Type: `Boolean`
+Default: `false`
+
+`winresourcer` is used to update Windows executable resources by default. `rcedit` can be used if preferred.
+
 ### Manifest Options
 
 #### platformOverrides

package/bin/nwbuild.cjs

@@ -4,7 +4,7 @@ const yargs = require("yargs/yargs");
 const { hideBin } = require("yargs/helpers");
 
 const { nwbuild } = require("../lib/index.cjs");
-const { Options, detectCurrentPlatform } = require("../dist/index.cjs");
+const { detectCurrentPlatform } = require("../dist/index.cjs");
 
 const cli = yargs(hideBin(process.argv))
   .version(false)
@@ -12,130 +12,110 @@ const cli = yargs(hideBin(process.argv))
   .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();
 

package/cfg/eslint.config.cjs

@@ -0,0 +1,17 @@
+module.exports = {
+  parserOptions: {
+    ecmaVersion: 2023,
+    sourceType: "module",
+  },
+  env: {
+    es6: true,
+    node: true,
+  },
+  extends: ["eslint:recommended", "tjw-jsdoc"],
+  rules: {
+    "jsdoc/require-file-overview": "off",
+    "jsdoc/require-returns-description": "off",
+    "jsdoc/match-description": "off",
+    "jsdoc/valid-types": "off",
+  },
+};

package/demo.cjs

@@ -0,0 +1,29 @@
+const fs = require("node:fs");
+const { resolve } = require("node:path");
+
+const NwBuilder = require("./lib/index.cjs");
+
+const nw = new NwBuilder({
+  files: ["package.json", "test/demo/*"],
+  platforms: ["linux64", "osx64", "win64"],
+  version: "0.67.1",
+});
+
+nw.build().then(() => {
+  let NW_manifest = JSON.parse(
+    fs.readFileSync("package.json", { encoding: "utf8" }),
+  );
+
+  NW_manifest.main = "test/demo/index.html";
+
+  const manifestPath = resolve(
+    "build",
+    "nw-builder",
+    "win64",
+    "package.nw",
+    "package.json",
+  );
+  const manifestData = JSON.stringify(NW_manifest);
+
+  fs.writeFileSync(manifestPath, manifestData, { encoding: "utf8" });
+});

package/docs/getting-started.md

@@ -72,8 +72,8 @@ Module usage:
 const { nwbuild } = require("nw-builder");
 
 nwbuild({
-    files: "./path/to/nw/app",
-    mode: "run",
+  files: "./path/to/nw/app",
+  mode: "run",
 });
 ```
 
@@ -93,10 +93,10 @@ Module usage:
 const { nwbuild } = require("nw-builder");
 
 nwbuild({
-    files: "./path/to/nw/app/dir/**/*.*",
-    flavor: "normal",
-    platforms: ["win32", "linux64"],
-    mode: "build",
+  files: "./path/to/nw/app/dir/**/*.*",
+  flavor: "normal",
+  platforms: ["win32", "linux64"],
+  mode: "build",
 });
 ```
 

package/e2e/test.js

@@ -0,0 +1,47 @@
+import { equal } from "node:assert";
+import { resolve } from "node:path";
+import { arch as ARCH, platform as PLATFORM } from "node:process";
+import { describe, it } from "node:test";
+
+import NwBuilder from "nw-builder";
+import { By } from "selenium-webdriver";
+import chrome from "selenium-webdriver/chrome.js";
+
+import { ARCH_KV, PLATFORM_KV } from "../src/util.js";
+
+const { Driver, ServiceBuilder, Options } = chrome;
+
+describe("test modes", async () => {
+  let driver = undefined;
+
+  let nwOptions = {
+    files: "test/demo/**",
+    version: "0.67.1",
+    flavor: "sdk",
+    cacheDir: "cache",
+  };
+
+  it("should run", async () => {
+    const nw = NwBuilder({ ...nwOptions });
+
+    nw.build();
+
+    const options = new Options();
+    const args = [`--nwapp=${resolve("test", "demo")}`, "--headless=new"];
+    options.addArguments(args);
+
+    const chromedriverPath = resolve(
+      nwOptions.cacheDir,
+      `nwjs${nwOptions.flavor === "sdk" ? "-sdk" : ""}-v${nwOptions.version}-${
+        PLATFORM_KV[PLATFORM]
+      }-${ARCH_KV[ARCH]}`,
+      `chromedriver${PLATFORM_KV[PLATFORM] === "win" ? ".exe" : ""}`,
+    );
+
+    const service = new ServiceBuilder(chromedriverPath).build();
+
+    driver = Driver.createSession(options, service);
+    const text = await driver.findElement(By.id("test")).getText();
+    equal(text, "Hello, World!");
+  });
+});