latex-stickies 1.3.3 → 1.3.5

package/package.json

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

package/scripts/brand-electron.js

@@ -18,6 +18,36 @@ 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.
+ *
+ * It caches an app's name from the first time it sees the path, and npm
+ * extracts Electron under a directory macOS indexes -- so it can record
+ * "Electron" before this script ever runs, and then keep showing that in the
+ * Dock however right the plist is. Renaming alone is not enough.
+ */
+function refreshLaunchServices(appPath) {
+  try {
+    execFileSync(
+      '/System/Library/Frameworks/CoreServices.framework/Frameworks'
+      + '/LaunchServices.framework/Support/lsregister',
+      ['-f', appPath],
+      { stdio: 'ignore', timeout: 10000 }
+    );
+  } catch (_) { /* the name is still right; only the cache is stale */ }
+}
 
 function main() {
   if (process.platform !== 'darwin') return; // only macOS names apps this way
@@ -42,15 +72,30 @@ function main() {
     }
   };
 
-  if (read('CFBundleName') === NAME) return; // already done
+  if (read('CFBundleName') === NAME && read('CFBundleIdentifier') === APP_ID) {
+    // 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
+    // says Electron" needs to know whether the rename failed or whether they
+    // are looking at an older instance still holding the single-instance lock.
+    if (process.env.LATEX_STICKIES_VERBOSE) {
+      console.log(`the Electron shell is already named "${NAME}"`);
+    }
+    return;
+  }
 
   const backup = fs.readFileSync(plist);
   try {
-    for (const key of ['CFBundleName', 'CFBundleDisplayName']) {
+    const fields = [
+      ['CFBundleName', NAME],
+      ['CFBundleDisplayName', NAME],
+      ['CFBundleIdentifier', APP_ID],
+    ];
+    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]);
       }
     }
 
@@ -66,6 +111,8 @@ function main() {
     });
     execFileSync('codesign', ['--verify', appPath], { stdio: 'ignore' });
 
+    refreshLaunchServices(appPath);
+
     console.log(`named the Electron shell "${NAME}"`);
   } catch (err) {
     fs.writeFileSync(plist, backup);