nw-builder 4.4.2 → 4.5.0

package/README.md

@@ -12,214 +12,83 @@ For version 3, please go to the [corresponding branch](https://github.com/nwutil
 - Get, run or build applications.
 - Integrate [FFmpeg community builds](https://github.com/nwjs-ffmpeg-prebuilt/nwjs-ffmpeg-prebuilt)
 - Configure executable fields and icons
-- Support downloading from mirrors
+- Downloading from mirrors
+- Node Native Addon support
 
 Check out the [documentation](https://nwutils.io/nw-builder/) if you wish to give `nw-builder` a try.
 
 > Please note that the documentation assumes you know [how to write NW.js applications](https://nwjs.readthedocs.io/en/latest/For%20Users/Getting%20Started/).
 
-## Alternatives
-
-- [nw-builder-platforms](https://github.com/naviapps/nw-builder-platforms) - Fork of this repo with platform specific build options
-- [nwjs-builder-phoenix](https://github.com/evshiron/nwjs-builder-phoenix) - Previously the most used build tool, however it is no longer maintained
-
-## Migration Guide (v3 -> v4)
-
-> We are working on making the migration process smoother. If you encounter any issues with the current guide, please open an issue or start a discussion.
-
-### Update `nw-builder`
+## Installation
 
 With npm:
 
 ```shell
-npm update nw-builder@latest
+npm install nw-builder -D
 ```
 
 With yarn:
 
 ```shell
-yarn upgrade nw-builder@latest
+yarn add nw-builder -D
 ```
 
 With pnpm:
 
 ```shell
-pnpm update nw-builder@latest
-```
-
-### Update options
-
-Let's take an example of v3 code and migrate it to v4.
-
-```javascript
-const NwBuilder = require("nw-builder");
-
-const nw = new NwBuilder({
-  files: ["./nwapp/**/*", "./other/**/*.js"],
-  version: "latest",
-  flavor: "normal",
-  platforms: ["win32", "win64", "osx32", "osx64", "linux32", "linux64"],
-  cacheDir: "./cache",
-  buildDir: "./build",
-  buildType: "versioned",
-  forceDownload: true,
-  appName: "nwdemo",
-  appVersion: "0.1.0",
-  argv: "--nw-stderr-logging",
-  macCredits: "./nwapp/credits.html",
-  macIcns: "./nwapp/mac.icns",
-  macPlist: { ... },
-  winVersionString: { ... },
-  winIco: "./nwapp/win.ico",
-  zip: true,
-  macZip: false,
-  mergeZip: false,
-});
-
-nw.build();
-```
-
-Update the import path
-
-```diff
--const NwBuilder = require("nw-builder");
-+const nwbuild = require("nw-builder");
-```
-
-Replace the `NwBuilder` initialization with a function
-
-```diff
--const nw = new NwBuilder({
-+await nwbuild({
-```
-
-The `files` property has been renamed to `srcDir`.
-
-```diff
--  files: ["./nwapp/**/*", "./other/**/*.js"],
-+  srcDir: "./nwapp/**/* ./other/**/*.js",
-```
-
-Add the `mode` option and remove the now redundant `nw.build` function call. The `build` call is made by `nwbuild` internally.
-
-```diff
-+  mode: "build",
-
--nw.build();
-```
-
-The `platforms` option has been removed and replaced with `platform` and `arch`. Notice that one `nwbuild` function call now creates one build for one platform and one arch only.
-
-```diff
--  platforms: ["win32", "win64", "osx32", "osx64", "linux32", "linux64"],
-+  platform: "linux", // "osx" for MacOS "win",  for Windows
-+  arch: "x64", // "ia32" for 32 bit or "arm64" for arm based 65 bit architectures
-```
-
-The `buildDir` option has been rename to `outDir`.
-
-```diff
--  buildDir: "./build",
-+  outDir: "./build",
-```
-
-The `buildType` option has been removed.
-
-```diff
--  buildType: "versioned",
-```
+pnpm add nw-builder -D
+```
+
+## Usage
+
+Here is two way to use nw-build to build your nwjs applications
+
+### CLI
+
+1. To get nwjs cache
+    ```bash
+    nwbuild --mode=get
+    ```
+2. To run nwjs application
+    ```bash
+    nwbuild --mode=run
+    ```
+3. To build nwjs application
+    ```bash
+    nwbuild --mode=build
+    ```
+
+### JavaScript API
+1. Define an npm script
+    ```json
+    {
+      "scripts": {
+        "build": "node scripts/build.js"
+      }
+    }
+    ```
+2. Create a build script
+    ```javascript
+    // scripts/build.js
+    const { nwbuild } = require("nw-builder");
+    await nwbuild({
+      srcDir: "./nwapp/**/* ./other/**/*.js",
+      mode: "build",
+      version: "latest",
+      flavor: "normal",
+      platform: "linux",
+      arch: "x64",
+      outDir: "./build",
+      cache: false,
+      app: { ... },
+    });
+    ```
+3. Run the script
+    ```bash
+    npm run build
+    ```
 
-The `forceDownload` option has been changed to `cache`.
-
-```diff
--  forceDownload: true,
-+  cache: false,
-```
-
-The `appName` option has been changed to `app.name`.
-
-```diff
--  appName: "nwdemo",
-+  app: { name: "nwdemo" },
-```
-
-The `appVersion` option has been changed to `app.version`.
-
-```diff
--  appVersion: "0.1.0",
-+  app: { version: "0.1.0" },
-```
-
-The `macCredit` option has been removed.
-
-```diff
--  macCredits: "./nwapp/credits.html",
-```
-
-The `macIcns` option has been replaced with `icon`.
-
-```diff
--  macIcns: "./nwapp/mac.icns",
-+  icon: "./nwapp/mac.icns",
-```
-
-The `macPlist` option has been replaced by `app.*` options. Consult the [documentation](https://nwutils.io/nw-builder/mode-build.html#osxrc-object) for valid properties.
-
-```diff
--  macPlist: { ... },
-+  app: { ... },
-```
-
-The `winVersionString` option has been replaced with `app`. Consult the [documentation](https://nwutils.io/nw-builder/mode-build.html#winrc-object) for valid properties.
-
-```diff
--  winVersionString: {
--    'CompanyName': 'Some Company',
--    'FileDescription': 'Process Name',
--    'ProductName': 'Some Product',
--    'LegalCopyright': 'Copyright 2017',
--  }
-+  app: {
-+    company: "Some Company",
-+    fileDescription: "Process Name",
-+    productName: "Some Product",
-+    legalCopyright: "Copyright (c) 2023",
-+  }
-```
-
-The `winIco` option has been replaced by `app.icon`.
-
-```diff
--  winIco: "./nwapp/win.ico",
-+  app: { icon: "./nwapp/win.ico" },
-```
-
-The `macZip` option has been removed.
-
-```diff
--  macZip: false,
-```
-
-The `mergeZip` option has been removed.
-
-```diff
--  mergeZip: false,
-```
+## Alternatives
 
-The final code should look like this.
-
-```javascript
-const { nwbuild } = require("nw-builder");
-
-await nwbuild({
-  srcDir: "./nwapp/**/* ./other/**/*.js",
-  mode: "build",
-  version: "latest",
-  flavor: "normal",
-  platform: "linux",
-  arch: "x64",
-  outDir: "./build",
-  cache: false,
-  app: { ... },
-});
-```
+- [nw-builder-platforms](https://github.com/naviapps/nw-builder-platforms) - Fork of this repo with platform specific build options
+- [nwjs-builder-phoenix](https://github.com/evshiron/nwjs-builder-phoenix) - Previously the most used build tool, however it is no longer maintained

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nw-builder",
-  "version": "4.4.2",
+  "version": "4.5.0",
   "description": "Build NW.js desktop applications for MacOS, Windows and Linux.",
   "keywords": [
     "NW.js",
@@ -32,7 +32,9 @@
   "types": "./src/index.d.ts",
   "type": "module",
   "files": [
-    "./src"
+    "LICENSE",
+    "patches",
+    "src"
   ],
   "homepage": "https://github.com/nwutils/nw-builder",
   "repository": {
@@ -40,38 +42,48 @@
     "url": "https://github.com/nwutils/nw-builder.git"
   },
   "scripts": {
-    "ci:fmt": "prettier --check \"./**/*.{css,html,js,json,md,yml}\"",
-    "ci:lnt": "eslint --config=.github/eslint.config.cjs .github src test",
-    "fmt": "prettier --write \"./**/*.{css,html,js,json,md,yml}\"",
-    "lnt": "eslint --config=.github/eslint.config.cjs --fix src test",
-    "doc:dev": "concurrently --kill-others \"node .github/fswatch.config.js\" \"vitepress dev doc\"",
-    "doc:bld": "node .github/jsdoc.config.cjs && vitepress build doc",
-    "test:unit": "node --test test/unit/index.js",
-    "test:e2e": "node --test test/e2e/index.js",
+    "lint": "eslint src/get.js",
+    "docs": "jsdoc -d docs ./src/get.js ./src/run.js ./src/bld.js",
+    "test": "node test/index.js",
     "demo": "cd test/fixture && node demo.js"
   },
   "devDependencies": {
-    "concurrently": "^8.2.1",
-    "eslint": "^8.51.0",
-    "eslint-config-tjw-jsdoc": "^1.0.4",
-    "gh-pages": "^6.0.0",
+    "eslint": "^8.56.0",
+    "eslint-plugin-jsdoc": "^46.9.1",
     "jsdoc": "^4.0.2",
-    "jsdoc-to-markdown": "^8.0.0",
-    "prettier": "^3.0.3",
-    "selenium-webdriver": "^4.14.0",
-    "vitepress": "^1.0.0-rc.21"
+    "selenium-webdriver": "^4.16.0"
   },
   "dependencies": {
     "cli-progress": "^3.12.0",
     "compressing": "^1.10.0",
     "glob": "^10.3.10",
+    "node-gyp": "^10.0.1",
     "plist": "^3.1.0",
-    "rcedit": "^4.0.0",
-    "winston": "^3.11.0",
+    "rcedit": "^4.0.1",
+    "tar": "^6.2.0",
+    "unzipper": "^0.10.14",
     "yargs": "^17.7.2"
   },
-  "packageManager": "npm@9.8.1",
+  "packageManager": "npm@10.2.4",
   "engines": {
-    "node": "^16.20.1 || ^18.18.2 || >= 20.8.1"
+    "node": ">=14"
+  },
+  "eslintConfig": {
+    "parserOptions": {
+      "ecmaVersion": 2023,
+      "sourceType": "module"
+    },
+    "env": {
+      "es6": true,
+      "node": true
+    },
+    "extends": [
+      "eslint:recommended",
+      "plugin:jsdoc/recommended"
+    ],
+    "rules": {
+      "jsdoc/tag-lines": "off",
+      "jsdoc/check-property-names": "off"
+    }
   }
 }

package/patches/node_header.patch

@@ -0,0 +1,4 @@
+68c68
+<     'v8_host_byteorder': '<!(python -c "import sys; print sys.byteorder")',
+---
+>     'v8_host_byteorder': '<!(python3 -c "import sys; print(sys.byteorder)")',