feat: update MacOS metadata (#894)

Author: Ayush C

doc/.vitepress/config.js

@@ -39,6 +39,10 @@ export default defineConfig({
             text: "Windows Specific Options",
             link: "/api-win.md#winrc-object",
           },
+          {
+            text: "MacOS Specific Options",
+            link: "/api-osx.md#osxrc-object",
+          },
         ],
       },
       {

package-lock.json

@@ -41,22 +41,22 @@
   "scripts": {
     "fmt": "prettier --write \"./**/*.{css,html,js,json,md,yml}\"",
     "lnt": "eslint --config=cfg/eslint.config.cjs --fix src",
-    "doc:api": "jsdoc2md ./src/index.js > ./doc/api.md && jsdoc2md ./src/bld/linuxCfg.js > ./doc/api-nux.md && jsdoc2md ./src/bld/winCfg.js > ./doc/api-win.md",
+    "doc:api": "jsdoc2md ./src/index.js > ./doc/api.md && jsdoc2md ./src/bld/linuxCfg.js > ./doc/api-nux.md && jsdoc2md ./src/bld/winCfg.js > ./doc/api-win.md && jsdoc2md ./src/bld/osxCfg.js > ./doc/api-osx.md",
     "doc:dev": "vitepress dev doc",
     "doc:bld": "vitepress build doc",
     "test:unit": "node --test-reporter=spec --test test/unit/index.js",
     "test:e2e": "node --test-reporter=spec --test test/e2e/index.js",
     "test:demo": "cd test/fixture && node demo.js"
   },
   "devDependencies": {
-    "eslint": "^8.43.0",
+    "eslint": "^8.44.0",
     "eslint-config-tjw-jsdoc": "^1.0.3",
     "gh-pages": "^5.0.0",
     "jsdoc": "^4.0.2",
     "jsdoc-to-markdown": "^8.0.0",
     "prettier": "^2.8.8",
     "selenium-webdriver": "^4.10.0",
-    "vitepress": "^1.0.0-beta.3"
+    "vitepress": "^1.0.0-beta.4"
   },
   "dependencies": {
     "cli-progress": "^3.12.0",

package.json

@@ -5,6 +5,7 @@ import { log } from "../log.js";
 
 /**
  * @typedef  {object}   LinuxRc               Linux configuration options
+ * @typedef  {string}   name                  Name of the application
  * @property {string}   genericName           Generic name of the application
  * @property {boolean}  noDisplay             If true the application is not displayed
  * @property {string}   comment               Tooltip for the entry, for example "View sites on the Internet".

src/bld/linuxCfg.js

@@ -1,13 +1,27 @@
 import { platform } from "node:process";
 import fs from "node:fs/promises";
-import path from "node:path";
+import { resolve } from "node:path";
 
 import plist from "plist";
 
 import { log } from "../log.js";
 
+/**
+ * @typedef {object}  OsxRc                      OSX resource configuration options
+ * @property {string} name                        The name of the application
+ * @property {string} LSApplicationCategoryType   The category that best describes your app for the App Store.
+ * @property {string} CFBundleIdentifier          A unique identifier for a bundle usually in reverse DNS format.
+ * @property {string} CFBundleName                A user-visible short name for the bundle.
+ * @property {string} CFBundleDisplayName         The user-visible name for the bundle.
+ * @property {string} CFBundleSpokenName          A replacement for the app name in text-to-speech operations.
+ * @property {string} CFBundleVersion             The version of the build that identifies an iteration of the bundle.
+ * @property {string} CFBundleShortVersionString  The release or version number of the bundle.
+ * @property {string} NSHumanReadableCopyright    A human-readable copyright notice for the bundle.
+ */
+
 /**
  * OSX specific configuration steps
+ * https://developer.apple.com/documentation/bundleresources/information_property_list
  *
  * @param  {object}             app     Resource configuration options for MacOS
  * @param  {string}             outDir  The directory to hold build artifacts
@@ -20,37 +34,31 @@ const setOsxConfig = async (app, outDir) => {
     );
   }
   try {
-    const outApp = path.resolve(outDir, `${app.name}.app`);
-    await fs.rename(path.resolve(outDir, "nwjs.app"), outApp);
+    const outApp = resolve(outDir, `${app.name}.app`);
+    await fs.rename(resolve(outDir, "nwjs.app"), outApp);
 
-    // Rename CFBundleDisplayName in Contents/Info.plist
-    const contentsInfoPlistPath = path.resolve(outApp, "Contents/Info.plist");
-    const contentsInfoPlistJson = plist.parse(
-      await fs.readFile(contentsInfoPlistPath, "utf-8")
-    );
-    contentsInfoPlistJson.CFBundleDisplayName = app.name;
-    const contentsInfoPlist = plist.build(contentsInfoPlistJson);
-    await fs.writeFile(contentsInfoPlistPath, contentsInfoPlist);
-
-    // Rename CFBundleDisplayName in Contents/Resources/en.lproj/InfoPlist.strings
-    const contentsInfoPlistStringsPath = path.resolve(
-      outApp,
-      "Contents/Resources/en.lproj/InfoPlist.strings"
+    const infoPlistPath = resolve(outApp, "Contents/Info.plist");
+    const infoPlistJson = plist.parse(
+      await fs.readFile(infoPlistPath, "utf-8")
     );
-    const contentsInfoPlistStrings = await fs.readFile(
-      contentsInfoPlistStringsPath,
-      "utf-8"
-    );
-    const newPlistStrings = contentsInfoPlistStrings.replace(
-      /CFBundleGetInfoString = "nwjs /,
-      `CFBundleGetInfoString = "${app.name} `
-    );
-    await fs.writeFile(contentsInfoPlistStringsPath, newPlistStrings);
 
-    // Add product_string property to package.json
-    // const packageJsonPath = path.resolve(outApp, "Contents/Resources/app.nw/package.json");
-    // app.product_string = app.name;
-    // await fs.writeFile(packageJsonPath, JSON.stringify(app, null, 4));
+    infoPlistJson.LSApplicationCategoryType = app.LSApplicationCategoryType;
+    infoPlistJson.CFBundleIdentifier = app.CFBundleIdentifier;
+    infoPlistJson.CFBundleName = app.CFBundleName;
+    infoPlistJson.CFBundleDisplayName = app.CFBundleDisplayName;
+    infoPlistJson.CFBundleSpokenName = app.CFBundleSpokenName;
+    infoPlistJson.CFBundleVersion = app.CFBundleVersion;
+    infoPlistJson.CFBundleShortVersionString = app.CFBundleShortVersionString;
+    infoPlistJson.NSHumanReadableCopyright = app.NSHumanReadableCopyright;
+    infoPlistJson.CFBundleIconFile = app.CFBundleIconFile;
+
+    Object.keys(infoPlistJson).forEach((option) => {
+      if (infoPlistJson[option] === undefined) {
+        delete infoPlistJson[option];
+      }
+    });
+
+    await fs.writeFile(infoPlistPath, plist.build(infoPlistJson));
   } catch (error) {
     log.error(error);
   }

src/bld/osxCfg.js

@@ -7,6 +7,8 @@ import { log } from "../log.js";
 
 /**
  * @typedef {object} WinRc              Windows configuration options
+ * @property {string} name              The name of the application
+ * @property {string} version           The version of the application
  * @property {string} comments          Additional information that should be displayed for diagnostic purposes.
  * @property {string} company           Company that produced the file—for example, Microsoft Corporation or Standard Microsystems Corporation, Inc. This string is required.
  * @property {string} fileDescription   File description to be presented to users. This string may be displayed in a list box when the user is choosing files to install. For example, Keyboard Driver for AT-Style Keyboards. This string is required.
@@ -58,7 +60,6 @@ const setWinConfig = async (app, outDir) => {
     await rename(resolve(outDir, "nw.exe"), outDirAppExe);
     await rcedit(outDirAppExe, {
       "file-version": app.version,
-      icon: app.icon,
       "product-version": app.version,
       "version-string": versionString,
     });

src/bld/winCfg.js

@@ -47,7 +47,6 @@ export const parse = async (options, pkg) => {
   // TODO(#737): move this out
   if (options.platform === "linux") {
     // linux desktop entry file configurations options
-    options.app.name = options.app.name ?? pkg.name;
     options.app.genericName = options.app.genericName ?? undefined;
     options.app.noDisplay = options.app.noDisplay ?? undefined;
     options.app.comment = options.app.comment ?? undefined;
@@ -73,6 +72,7 @@ export const parse = async (options, pkg) => {
   }
   if (options.platform === "win") {
     // windows configuration options
+    options.app.version = options.app.version ?? pkg.version;
     options.app.comments = options.app.comments ?? undefined;
     options.app.company = options.app.company ?? pkg.author;
     options.app.fileDescription =
@@ -88,5 +88,22 @@ export const parse = async (options, pkg) => {
     options.app.specialBuild = options.app.specialBuild ?? undefined;
   }
 
+  if (options.platform === "osx") {
+    options.app.LSApplicationCategoryType =
+      options.app.LSApplicationCategoryType ?? undefined;
+    options.app.CFBundleIdentifier =
+      options.app.CFBundleIdentifier ?? options.app.name;
+    options.app.CFBundleName = options.app.CFBundleName ?? pkg.name;
+    options.app.CFBundleDisplayName =
+      options.app.CFBundleDisplayName ?? pkg.name;
+    options.app.CFBundleSpokenName = options.app.CFBundleSpokenName ?? pkg.name;
+    options.app.CFBundleShortVersionString =
+      options.app.CFBundleVersion ?? pkg.version;
+    options.app.CFBundleVersion =
+      options.app.CFBundleShortVersionString ?? pkg.version;
+    options.app.NSHumanReadableCopyright =
+      options.app.NSHumanReadableCopyright ?? undefined;
+  }
+
   return { ...options };
 };

src/util/parse.js

@@ -3,9 +3,9 @@ import { readdir } from "node:fs/promises";
 /**
  * Validate options
  *
- * @param  {import("../../index.js").OPTIONS} options      Options
- * @param  {object}                           releaseInfo  Version specific NW release info
- * @return {Promise<undefined>}                            Return undefined if options are valid
+ * @param  {import("../index.js").Options} options      Options
+ * @param  {object}                        releaseInfo  Version specific NW release info
+ * @return {Promise<undefined>}                         Return undefined if options are valid
  * @throws {Error}                                         Throw error if options are invalid
  */
 export const validate = async (options, releaseInfo) => {

src/util/validate.js

@@ -1,4 +1,8 @@
 {
   "name": "nwapp",
-  "main": "index.html"
+  "main": "index.html",
+  "version": "0.0.0",
+  "window": {
+    "icon": "icon.ico"
+  }
 }