nw-builder 4.17.12 → 4.18.0

package/src/bld.js

@@ -1,17 +1,17 @@
-import child_process from 'node:child_process';
-import console from 'node:console';
-import fs from 'node:fs';
-import path from 'node:path';
-import process from 'node:process';
-
-import archiver from 'archiver';
-import * as resedit from 'resedit';
+import child_process from "node:child_process";
+import console from "node:console";
+import fs from "node:fs";
+import path from "node:path";
+import process from "node:process";
+
+import { ZipArchive } from "archiver";
+import * as resedit from "resedit";
 // pe-library is a direct dependency of resedit
-import * as peLibrary from 'pe-library';
-import * as tar from 'tar';
+import * as peLibrary from "pe-library";
+import * as tar from "tar";
 
-import util from './util.js';
-import setOsxConfig from './bld/osx.js';
+import util from "./util.js";
+import setOsxConfig from "./bld/osx.js";
 
 /**
  * References:
@@ -108,13 +108,13 @@ import setOsxConfig from './bld/osx.js';
  * @returns {Promise<void>}
  */
 async function bld({
-  version = 'latest',
-  flavor = 'normal',
+  version = "latest",
+  flavor = "normal",
   platform = util.PLATFORM_KV[process.platform],
   arch = util.ARCH_KV[process.arch],
-  srcDir = './src',
-  cacheDir = './cache',
-  outDir = './out',
+  srcDir = "./src",
+  cacheDir = "./cache",
+  outDir = "./out",
   app,
   glob = true,
   managedManifest = false,
@@ -123,20 +123,20 @@ async function bld({
 }) {
   const nwDir = path.resolve(
     cacheDir,
-    `nwjs${flavor === 'sdk' ? '-sdk' : ''}-v${version}-${platform
-    }-${arch}`,
+    `nwjs${flavor === "sdk" ? "-sdk" : ""}-v${version}-${platform}-${arch}`,
   );
 
   await fs.promises.rm(outDir, { force: true, recursive: true });
-  await fs.promises.cp(nwDir, outDir, { recursive: true, verbatimSymlinks: true });
+  await fs.promises.cp(nwDir, outDir, {
+    recursive: true,
+    verbatimSymlinks: true,
+  });
 
   const files = await util.globFiles({ srcDir, glob });
 
   const nwProjectDir = path.resolve(
     outDir,
-    platform !== 'osx'
-      ? 'package.nw'
-      : 'nwjs.app/Contents/Resources/app.nw',
+    platform !== "osx" ? "package.nw" : "nwjs.app/Contents/Resources/app.nw",
   );
 
   await fs.promises.mkdir(nwProjectDir, { recursive: true });
@@ -147,46 +147,52 @@ async function bld({
       if (stats.isDirectory()) {
         continue;
       }
-      await fs.promises.cp(
-        file,
-        path.resolve(
-          nwProjectDir,
-          file,
-        ),
-        { recursive: true, force: true },
-      );
+      await fs.promises.cp(file, path.resolve(nwProjectDir, file), {
+        recursive: true,
+        force: true,
+      });
     }
   } else {
-    await fs.promises.cp(
-      files,
-      path.resolve(
-        nwProjectDir,
-      ),
-      { recursive: true, verbatimSymlinks: true },
-    );
+    await fs.promises.cp(files, path.resolve(nwProjectDir), {
+      recursive: true,
+      verbatimSymlinks: true,
+    });
   }
 
-  const builtManifest = JSON.parse(await fs.promises.readFile(path.resolve(nwProjectDir, 'package.json'), 'utf8'));
+  const builtManifest = JSON.parse(
+    await fs.promises.readFile(
+      path.resolve(nwProjectDir, "package.json"),
+      "utf8",
+    ),
+  );
 
   /* Set `product_string` in manifest for MacOS. This is used in renaming the Helper apps. */
-  if (platform === 'osx') {
+  if (platform === "osx") {
     builtManifest.product_string = app.name;
-    await fs.promises.writeFile(path.resolve(nwProjectDir, 'package.json'), JSON.stringify(builtManifest, null, 2));
+    await fs.promises.writeFile(
+      path.resolve(nwProjectDir, "package.json"),
+      JSON.stringify(builtManifest, null, 2),
+    );
   }
 
   if (
     managedManifest === true ||
-    typeof managedManifest === 'object' ||
-    typeof managedManifest === 'string'
+    typeof managedManifest === "object" ||
+    typeof managedManifest === "string"
   ) {
-    await manageManifest({ nwPkg: builtManifest, managedManifest, outDir, platform });
+    await manageManifest({
+      nwPkg: builtManifest,
+      managedManifest,
+      outDir,
+      platform,
+    });
   }
 
-  if (platform === 'linux') {
+  if (platform === "linux") {
     await setLinuxConfig({ app, outDir });
-  } else if (platform === 'win') {
+  } else if (platform === "win") {
     await setWinConfig({ app, outDir });
-  } else if (platform === 'osx') {
+  } else if (platform === "osx") {
     await setOsxConfig({ version, app, outDir, releaseInfo });
   }
 
@@ -202,61 +208,57 @@ const manageManifest = async ({ nwPkg, managedManifest, outDir, platform }) => {
     manifest = nwPkg;
   }
 
-  if (typeof managedManifest === 'object') {
+  if (typeof managedManifest === "object") {
     manifest = managedManifest;
   }
 
-  if (typeof managedManifest === 'string') {
+  if (typeof managedManifest === "string") {
     manifest = JSON.parse(await fs.promises.readFile(managedManifest));
   }
 
   if (manifest.devDependencies) {
     manifest.devDependencies = undefined;
   }
-  manifest.packageManager = manifest.packageManager ?? 'npm@*';
+  manifest.packageManager = manifest.packageManager ?? "npm@*";
 
   await fs.promises.writeFile(
     path.resolve(
       outDir,
-      platform !== 'osx'
-        ? 'package.nw'
-        : 'nwjs.app/Contents/Resources/app.nw',
-      'package.json',
+      platform !== "osx" ? "package.nw" : "nwjs.app/Contents/Resources/app.nw",
+      "package.json",
     ),
     JSON.stringify(manifest, null, 2),
-    'utf8',
+    "utf8",
   );
 
   const cwd = path.resolve(
     outDir,
-    platform !== 'osx'
-      ? 'package.nw'
-      : 'nwjs.app/Contents/Resources/app.nw',
+    platform !== "osx" ? "package.nw" : "nwjs.app/Contents/Resources/app.nw",
   );
 
-  if (manifest.packageManager.startsWith('npm')) {
-    child_process.execSync('npm install', { cwd });
-  } else if (manifest.packageManager.startsWith('yarn')) {
-    child_process.execSync('yarn install', { cwd });
-  } else if (manifest.packageManager.startsWith('pnpm')) {
-    child_process.execSync('pnpm install', { cwd });
+  if (manifest.packageManager.startsWith("npm")) {
+    child_process.execSync("npm install", { cwd });
+  } else if (manifest.packageManager.startsWith("yarn")) {
+    child_process.execSync("yarn install", { cwd });
+  } else if (manifest.packageManager.startsWith("pnpm")) {
+    child_process.execSync("pnpm install", { cwd });
   }
 };
 
 const setLinuxConfig = async ({ app, outDir }) => {
-  if (process.platform === 'win32') {
+  if (process.platform === "win32") {
     console.warn(
-      'Linux apps built on Windows platform do not preserve all file permissions. See #716',
+      "Linux apps built on Windows platform do not preserve all file permissions. See #716",
     );
   }
   let desktopEntryFile = {
-    Type: 'Application',
-    Version: '1.5',
+    Type: "Application",
+    Version: "1.5",
     Name: app.name,
     GenericName: app.genericName,
     NoDisplay: app.noDisplay,
     Comment: app.comment,
-    Icon: app.icon ? path.resolve(outDir, 'package.nw', app.icon) : '',
+    Icon: app.icon ? path.resolve(outDir, "package.nw", app.icon) : "",
     Hidden: app.hidden,
     OnlyShowIn: app.onlyShowIn,
     NotShowIn: app.notShowIn,
@@ -278,7 +280,7 @@ const setLinuxConfig = async ({ app, outDir }) => {
 
   await fs.promises.rename(`${outDir}/nw`, `${outDir}/${app.name}`);
 
-  let fileContent = '[Desktop Entry]\n';
+  let fileContent = "[Desktop Entry]\n";
   Object.keys(desktopEntryFile).forEach((key) => {
     if (desktopEntryFile[key] !== undefined) {
       fileContent += `${key}=${desktopEntryFile[key]}\n`;
@@ -311,21 +313,25 @@ const setWinConfig = async ({ app, outDir }) => {
   });
 
   const outDirAppExe = path.resolve(outDir, `${app.name}.exe`);
-  await fs.promises.rename(path.resolve(outDir, 'nw.exe'), outDirAppExe);
-  const exe = peLibrary.NtExecutable.from(await fs.promises.readFile(outDirAppExe));
+  await fs.promises.rename(path.resolve(outDir, "nw.exe"), outDirAppExe);
+  const exe = peLibrary.NtExecutable.from(
+    await fs.promises.readFile(outDirAppExe),
+  );
   const res = peLibrary.NtExecutableResource.from(exe);
   // English (United States)
   const EN_US = 1033;
   if (app.icon) {
     const iconBuffer = await fs.promises.readFile(path.resolve(app.icon));
     const iconFile = resedit.Data.IconFile.from(iconBuffer);
-    const iconGroupIDs = resedit.Resource.IconGroupEntry.fromEntries(res.entries).map((entry) => entry.id);
+    const iconGroupIDs = resedit.Resource.IconGroupEntry.fromEntries(
+      res.entries,
+    ).map((entry) => entry.id);
     resedit.Resource.IconGroupEntry.replaceIconsForResource(
       res.entries,
       /*  Should be `IDR_MAINFRAME` */
       iconGroupIDs[0],
       EN_US,
-      iconFile.icons.map(i => i.data)
+      iconFile.icons.map((i) => i.data),
     );
   }
   const [vi] = resedit.Resource.VersionInfo.fromEntries(res.entries);
@@ -339,36 +345,42 @@ const setWinConfig = async ({ app, outDir }) => {
   }
   vi.setFileVersion(app.fileVersion, app.languageCode);
   vi.setProductVersion(app.productVersion, app.languageCode);
-  vi.setStringValues({
-    lang: app.languageCode,
-    codepage: 1200
-  }, versionString);
+  vi.setStringValues(
+    {
+      lang: app.languageCode,
+      codepage: 1200,
+    },
+    versionString,
+  );
   vi.outputToResourceEntries(res.entries);
   res.outputResource(exe);
   const outBuffer = Buffer.from(exe.generate());
   await fs.promises.writeFile(outDirAppExe, outBuffer);
 };
 
-const compress = async ({
-  zip,
-  outDir,
-}) => {
-  if (zip === true || zip === 'zip') {
-    const archive = archiver('zip');
+const compress = async ({ zip, outDir }) => {
+  if (zip === true || zip === "zip") {
+    const archive = new ZipArchive();
     const writeStream = fs.createWriteStream(`${outDir}.zip`);
     archive.pipe(writeStream);
     archive.directory(outDir, false);
     await archive.finalize();
-  } else if (zip === 'tar') {
-    await tar.create({
-      gzip: false,
-      file: `${outDir}.tar`,
-    }, [outDir]);
-  } else if (zip === 'tgz') {
-    await tar.create({
-      gzip: true,
-      file: `${outDir}.tgz`,
-    }, [outDir]);
+  } else if (zip === "tar") {
+    await tar.create(
+      {
+        gzip: false,
+        file: `${outDir}.tar`,
+      },
+      [outDir],
+    );
+  } else if (zip === "tgz") {
+    await tar.create(
+      {
+        gzip: true,
+        file: `${outDir}.tgz`,
+      },
+      [outDir],
+    );
   }
 
   await fs.promises.rm(outDir, { recursive: true, force: true });

package/src/cli.js

@@ -1,31 +1,51 @@
 #!/usr/bin/env node
 
-import process from 'node:process';
-import { program } from 'commander';
+import process from "node:process";
+import { program } from "commander";
 
-import nwbuild from './index.js';
-import util from './util.js';
+import nwbuild from "./index.js";
+import util from "./util.js";
 
 program
-  .argument('<string>', 'File path(s) to project')
-  .option('--mode <string>', 'get, run or build mode', 'build')
-  .option('--version <string>', 'NW.js version', 'latest')
-  .option('--flavor <string>', 'NW.js build flavor', 'normal')
-  .option('--platform <string>', 'NW.js supported platform', util.PLATFORM_KV[process.platform])
-  .option('--arch <string>', 'NW.js supported architecture', util.ARCH_KV[process.arch])
-  .option('--downloadUrl <string>', 'NW.js download server', 'https://dl.nwjs.io')
-  .option('--manifestUrl <string>', 'NW.js versions manifest URI', 'https://nwjs.io/versions.json')
-  .option('--cacheDir <string>', 'Cache NW.js binaries', './cache')
-  .option('--outDir <string>', 'NW.js build artifacts', './out')
-  .option('--app <object>', 'Platform specific app metadata. Refer to docs for more info', {})
-  .option('--cache <boolean>', 'Enable/disable caching', true)
-  .option('--ffmpeg <boolean>', 'Enable/disable community ffmpeg', false)
-  .option('--glob <boolean>', 'Enable/disable globbing', true)
-  .option('--logLevel <string>', 'Specify log level', 'info')
-  .option('--shaSum <boolean>', 'Enable/disable shasum', true)
-  .option('--zip <string>', 'Enable/disable compression', false)
-  .option('--managedManifest <string>', 'Managed manifest mode', false)
-  .option('--nodeAddon <boolean>', 'Download NW.js Node headers', false)
+  .argument("<string>", "File path(s) to project")
+  .option("--mode <string>", "get, run or build mode", "build")
+  .option("--version <string>", "NW.js version", "latest")
+  .option("--flavor <string>", "NW.js build flavor", "normal")
+  .option(
+    "--platform <string>",
+    "NW.js supported platform",
+    util.PLATFORM_KV[process.platform],
+  )
+  .option(
+    "--arch <string>",
+    "NW.js supported architecture",
+    util.ARCH_KV[process.arch],
+  )
+  .option(
+    "--downloadUrl <string>",
+    "NW.js download server",
+    "https://dl.nwjs.io",
+  )
+  .option(
+    "--manifestUrl <string>",
+    "NW.js versions manifest URI",
+    "https://nwjs.io/versions.json",
+  )
+  .option("--cacheDir <string>", "Cache NW.js binaries", "./cache")
+  .option("--outDir <string>", "NW.js build artifacts", "./out")
+  .option(
+    "--app <object>",
+    "Platform specific app metadata. Refer to docs for more info",
+    {},
+  )
+  .option("--cache <boolean>", "Enable/disable caching", true)
+  .option("--ffmpeg <boolean>", "Enable/disable community ffmpeg", false)
+  .option("--glob <boolean>", "Enable/disable globbing", true)
+  .option("--logLevel <string>", "Specify log level", "info")
+  .option("--shaSum <boolean>", "Enable/disable shasum", true)
+  .option("--zip <string>", "Enable/disable compression", false)
+  .option("--managedManifest <string>", "Managed manifest mode", false)
+  .option("--nodeAddon <boolean>", "Download NW.js Node headers", false)
   .allowUnknownOption(true)
   .allowExcessArguments(true);
 
@@ -44,7 +64,7 @@ for (const arg of unknownArgs) {
 const opts = {
   ...program.opts(),
   app: appConfig,
-  srcDir: program.args.find((arg) => !arg.startsWith('--app')),
+  srcDir: program.args.find((arg) => !arg.startsWith("--app")),
   cli: true,
 };