latex-stickies 1.3.4 → 1.3.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "latex-stickies",
-  "version": "1.3.4",
+  "version": "1.3.6",
   "description": "Sticky notes for your desktop that render LaTeX and Markdown.",
   "main": "src/main.js",
   "scripts": {

package/scripts/brand-electron.js

@@ -18,6 +18,17 @@ const fs = require('fs');
 const path = require('path');
 
 const NAME = 'LaTeX Stickies';
+/**
+ * Our own bundle identifier, matching the packaged builds.
+ *
+ * The Electron shell ships as com.github.Electron, and LaunchServices keys its
+ * database by identifier rather than by path. So on a machine that has seen any
+ * other Electron -- another project's node_modules, an old npx copy, a
+ * different Electron app entirely -- the Dock can serve that record's name,
+ * "Electron", however carefully this script renames our copy. Taking our own
+ * identifier is what stops the collision; renaming alone cannot.
+ */
+const APP_ID = 'com.kevinjusak.latexsticky';
 
 /**
  * Makes LaunchServices re-read a bundle.
@@ -61,7 +72,10 @@ function main() {
     }
   };
 
-  if (read('CFBundleName') === NAME) {
+  const binary = path.join(appPath, 'Contents', 'MacOS', NAME);
+  if (read('CFBundleName') === NAME
+      && read('CFBundleIdentifier') === APP_ID
+      && fs.existsSync(binary)) {
     // Already named, so a wrong name in the Dock can only be a stale cache.
     refreshLaunchServices(appPath);
     // Say so rather than exiting in silence. A user reporting "the Dock still
@@ -75,14 +89,35 @@ function main() {
 
   const backup = fs.readFileSync(plist);
   try {
-    for (const key of ['CFBundleName', 'CFBundleDisplayName']) {
+    const fields = [
+      ['CFBundleName', NAME],
+      ['CFBundleDisplayName', NAME],
+      ['CFBundleIdentifier', APP_ID],
+      ['CFBundleExecutable', NAME],
+    ];
+    for (const [key, value] of fields) {
       try {
-        execFileSync('plutil', ['-replace', key, '-string', NAME, plist]);
+        execFileSync('plutil', ['-replace', key, '-string', value, plist]);
       } catch (_) {
-        execFileSync('plutil', ['-insert', key, '-string', NAME, plist]);
+        execFileSync('plutil', ['-insert', key, '-string', value, plist]);
       }
     }
 
+    // Rename the executable too. macOS takes the Dock label from the running
+    // executable, not only from the plist -- which is why the packaged builds
+    // have always shown the right name (electron-builder renames it) while
+    // every npm install showed "Electron" however the plist was rewritten.
+    const oldBinary = path.join(appPath, 'Contents', 'MacOS', 'Electron');
+    if (fs.existsSync(oldBinary) && !fs.existsSync(binary)) {
+      fs.renameSync(oldBinary, binary);
+    }
+    // require('electron') reads this file for the path it returns, so it has
+    // to follow the rename or every launcher breaks.
+    const pathTxt = path.join(path.dirname(appPath), '..', 'path.txt');
+    if (fs.existsSync(pathTxt)) {
+      fs.writeFileSync(pathTxt, `Electron.app/Contents/MacOS/${NAME}`);
+    }
+
     // The bundle icon is what shows before the app can set its own.
     const icon = path.join(__dirname, '..', 'build', 'icon.icns');
     const target = path.join(appPath, 'Contents', 'Resources', 'electron.icns');