@vscode/gulp-electron 1.38.1 → 1.40.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vscode/gulp-electron",
-  "version": "1.38.1",
+  "version": "1.40.0",
   "description": "gulp plugin for packaging Electron into VS Code",
   "main": "src/index.js",
   "scripts": {

package/src/darwin.js

@@ -12,6 +12,22 @@ function getOriginalAppName(opts) {
   return semver.gte(opts.version, "0.24.0") ? "Electron" : "Atom";
 }
 
+function getOriginalMiniAppName(opts) {
+  return getOriginalAppName(opts) + " MiniApp";
+}
+
+function getOriginalMiniAppFullName(opts) {
+  return getOriginalMiniAppName(opts) + ".app";
+}
+
+function getMiniAppName(opts) {
+  return opts.darwinMiniAppName || opts.productName + " MiniApp";
+}
+
+function getMiniAppFullName(opts) {
+  return getMiniAppName(opts) + ".app";
+}
+
 function getOriginalAppFullName(opts) {
   return getOriginalAppName(opts) + ".app";
 }
@@ -226,11 +242,9 @@ function patchHelperInfoPlist(opts) {
   var input = es.through();
   var output = input.pipe(
     es.map(function (f, cb) {
-      if (
-        !/Contents\/Frameworks\/Electron\ Helper( \w+)?\.app\/Contents\/Info.plist$/i.test(
-          f.relative
-        )
-      ) {
+      const match = /Contents\/Frameworks\/Electron\ Helper( \(\w+\))?\.app\/Contents\/Info.plist$/i.exec(
+        f.relative);
+      if (!match) {
         return cb(null, f);
       }
 
@@ -246,24 +260,14 @@ function patchHelperInfoPlist(opts) {
 
       f.contents.on("end", function () {
         var infoPlist = plist.parse(contents.toString("utf8"));
-        var match = /\.helper\.([^.]+)$/.exec(
-          infoPlist["CFBundleIdentifier"] || ""
-        );
-        var suffix = match ? match[1] : "";
+        var suffix = match[1] ?? "";
 
         if (opts.darwinBundleIdentifier) {
           infoPlist["CFBundleIdentifier"] =
             opts.darwinBundleIdentifier + ".helper";
-
-          if (suffix) {
-            infoPlist["CFBundleIdentifier"] += "." + suffix;
-          }
         }
 
-        infoPlist["CFBundleName"] = opts.productName + " Helper";
-        if (suffix) {
-          infoPlist["CFBundleName"] += " " + suffix;
-        }
+        infoPlist["CFBundleName"] = `${opts.productName} Helper${suffix}`;
 
         if (infoPlist["CFBundleDisplayName"]) {
           infoPlist["CFBundleDisplayName"] = infoPlist["CFBundleName"];
@@ -293,6 +297,177 @@ function patchHelperInfoPlist(opts) {
   return es.duplex(input, es.merge(output, icons));
 }
 
+function patchMiniAppInfoPlist(opts) {
+  if (!opts.darwinMiniAppName) {
+    return es.through();
+  }
+
+  var input = es.through();
+  var output = input.pipe(
+    es.map(function (f, cb) {
+      // Match MiniApp's Info.plist at Contents/Applications/*/Contents/Info.plist
+      const match = /Contents\/Applications\/[^\/]+\.app\/Contents\/Info.plist$/i.exec(
+        f.relative);
+      if (!match) {
+        return cb(null, f);
+      }
+
+      var contents = "";
+
+      f.contents.on("error", function (err) {
+        cb(err);
+      });
+
+      f.contents.on("data", function (d) {
+        contents += d;
+      });
+
+      f.contents.on("end", function () {
+        var infoPlist = plist.parse(contents.toString("utf8"));
+
+        var miniAppName = getMiniAppName(opts);
+
+        // Bundle identifier
+        if (opts.darwinMiniAppBundleIdentifier) {
+          infoPlist["CFBundleIdentifier"] = opts.darwinMiniAppBundleIdentifier;
+        } else if (opts.darwinBundleIdentifier) {
+          infoPlist["CFBundleIdentifier"] = opts.darwinBundleIdentifier + ".miniapp";
+        }
+
+        // Name and display name
+        infoPlist["CFBundleName"] = miniAppName;
+        infoPlist["CFBundleDisplayName"] = opts.darwinMiniAppDisplayName || miniAppName;
+
+        // Executable name
+        infoPlist["CFBundleExecutable"] = miniAppName;
+
+        // Version info
+        infoPlist["CFBundleVersion"] = opts.productVersion;
+        infoPlist["CFBundleShortVersionString"] = opts.productVersion;
+
+        // Icon file
+        if (opts.darwinMiniAppIcon) {
+          infoPlist["CFBundleIconFile"] = path.basename(opts.darwinMiniAppIcon);
+        }
+
+        // Copyright
+        if (opts.copyright) {
+          infoPlist["NSHumanReadableCopyright"] = opts.copyright;
+        }
+
+        // Update host bundle reference
+        if (opts.darwinBundleIdentifier) {
+          infoPlist["ElectronHostBundleId"] = opts.darwinBundleIdentifier;
+        }
+
+        f.contents = Buffer.from(plist.build(infoPlist), "utf8");
+        cb(null, f);
+      });
+    })
+  );
+
+  return es.duplex(input, output);
+}
+
+function patchMiniAppHelperInfoPlist(opts) {
+  if (!opts.darwinMiniAppName) {
+    return es.through();
+  }
+
+  var input = es.through();
+  var output = input.pipe(
+    es.map(function (f, cb) {
+      // Match MiniApp Helper's Info.plist at Contents/Applications/*/Contents/Frameworks/Helper*.app/Contents/Info.plist
+      const match = /Contents\/Applications\/[^\/]+\.app\/Contents\/Frameworks\/[^\/]+\ Helper( \(\w+\))?\.app\/Contents\/Info.plist$/i.exec(
+        f.relative);
+      if (!match) {
+        return cb(null, f);
+      }
+
+      var contents = "";
+
+      f.contents.on("error", function (err) {
+        cb(err);
+      });
+
+      f.contents.on("data", function (d) {
+        contents += d;
+      });
+
+      f.contents.on("end", function () {
+        var infoPlist = plist.parse(contents.toString("utf8"));
+        var suffix = match[1] ?? "";
+
+        var miniAppName = getMiniAppName(opts);
+        var helperName = miniAppName + " Helper" + suffix;
+
+        // Bundle identifier
+        if (opts.darwinMiniAppBundleIdentifier) {
+          infoPlist["CFBundleIdentifier"] = opts.darwinMiniAppBundleIdentifier + ".helper";
+        } else if (opts.darwinBundleIdentifier) {
+          infoPlist["CFBundleIdentifier"] = opts.darwinBundleIdentifier + ".miniapp.helper";
+        }
+
+        infoPlist["CFBundleName"] = helperName;
+
+        if (infoPlist["CFBundleDisplayName"]) {
+          infoPlist["CFBundleDisplayName"] = helperName;
+        }
+
+        if (infoPlist["CFBundleExecutable"]) {
+          infoPlist["CFBundleExecutable"] = helperName;
+        }
+
+        f.contents = Buffer.from(plist.build(infoPlist), "utf8");
+        cb(null, f);
+      });
+    })
+  );
+
+  return es.duplex(input, output);
+}
+
+function patchMiniAppIcon(opts) {
+  if (!opts.darwinMiniAppName || !opts.darwinMiniAppIcon) {
+    return es.through();
+  }
+
+  var originalIconPath = path.join(
+    getOriginalAppFullName(opts),
+    "Contents",
+    "Applications",
+    getOriginalMiniAppFullName(opts),
+    "Contents",
+    "Resources",
+    "miniapp.icns"
+  );
+  var iconPath = path.join(
+    getOriginalAppFullName(opts),
+    "Contents",
+    "Applications",
+    getOriginalMiniAppFullName(opts),
+    "Contents",
+    "Resources",
+    path.basename(opts.darwinMiniAppIcon)
+  );
+
+  var pass = es.through();
+
+  // filter out original icon
+  var src = pass.pipe(
+    es.mapSync(function (f) {
+      if (f.relative !== originalIconPath) {
+        return f;
+      }
+    })
+  );
+
+  // add custom icon
+  var icon = vfs.src(opts.darwinMiniAppIcon).pipe(rename(iconPath));
+
+  return es.duplex(pass, es.merge(src, icon));
+}
+
 function addCredits(opts) {
   if (!opts.darwinCredits) {
     return es.through();
@@ -407,6 +582,107 @@ function renameAppHelper(opts) {
   });
 }
 
+function renameMiniApp(opts) {
+  if (!opts.darwinMiniAppName) {
+    return es.through();
+  }
+
+  var originalMiniAppName = getOriginalMiniAppName(opts);
+  var originalMiniAppFullName = getOriginalMiniAppFullName(opts);
+  var miniAppName = getMiniAppName(opts);
+  var miniAppFullName = getMiniAppFullName(opts);
+
+  return rename(function (path) {
+    // Check if this is inside the Applications folder
+    if (!/Contents\/Applications/.test(path.dirname) && 
+        !(path.dirname === "." && path.basename === originalMiniAppName && /Contents\/Applications$/.test(path.dirname))) {
+      // Not a miniapp path, but check if dirname contains Applications
+      if (!path.dirname.includes("Contents/Applications")) {
+        return;
+      }
+    }
+
+    // Rename the MiniApp.app folder itself
+    if (
+      /Contents\/Applications$/.test(path.dirname) &&
+      path.basename === originalMiniAppName &&
+      path.extname === ".app"
+    ) {
+      path.basename = miniAppName;
+      return;
+    }
+
+    // Rename paths inside MiniApp.app
+    if (path.dirname.includes(originalMiniAppFullName)) {
+      path.dirname = path.dirname.replace(
+        originalMiniAppFullName,
+        miniAppFullName
+      );
+    }
+
+    // Rename the MiniApp executable in MacOS folder
+    if (
+      /Contents\/Applications\/[^\/]+\.app\/Contents\/MacOS$/.test(path.dirname) &&
+      path.basename === originalMiniAppName &&
+      path.extname === ""
+    ) {
+      path.basename = miniAppName;
+    }
+  });
+}
+
+function renameMiniAppHelper(opts) {
+  if (!opts.darwinMiniAppName) {
+    return es.through();
+  }
+
+  var originalMiniAppHelperName = getOriginalMiniAppName(opts) + " Helper";
+  var miniAppName = getMiniAppName(opts);
+
+  return rename(function (path) {
+    // Only process paths inside MiniApp's Frameworks
+    if (!/Contents\/Applications\/[^\/]+\.app\/Contents\/Frameworks/.test(path.dirname) &&
+        !/Contents\/Applications\/[^\/]+\.app\/Contents\/Frameworks$/.test(path.dirname + "/" + path.basename)) {
+      // Check if the path is the helper app folder itself
+      if (!/Contents\/Applications/.test(path.dirname)) {
+        return;
+      }
+    }
+    
+    // Rename the helper .app folder
+    if (
+      /Contents\/Applications\/[^\/]+\.app\/Contents\/Frameworks$/.test(path.dirname) &&
+      path.extname === ".app"
+    ) {
+      var basenameMatch = /^Electron MiniApp Helper( \(\w+\))?$/.exec(path.basename);
+      if (basenameMatch) {
+        var suffix = basenameMatch[1] || "";
+        path.basename = miniAppName + " Helper" + suffix;
+        return;
+      }
+    }
+
+    // Rename paths inside MiniApp Helper.app
+    var helperDirMatch = /Electron\ MiniApp\ Helper( \(\w+\))?\.app/.exec(path.dirname);
+    if (helperDirMatch) {
+      var suffix = helperDirMatch[1] || "";
+      path.dirname = path.dirname.replace(
+        /Electron\ MiniApp\ Helper( \(\w+\))?\.app/,
+        miniAppName + " Helper$1.app"
+      );
+
+      // Rename the helper executable
+      var execMatch = /Contents\/Applications\/[^\/]+\.app\/Contents\/Frameworks\/[^\/]+\.app\/Contents\/MacOS$/.test(path.dirname);
+      if (execMatch) {
+        var execNameMatch = /^Electron MiniApp Helper( \(\w+\))?$/.exec(path.basename);
+        if (execNameMatch && path.extname === "") {
+          path.basename = miniAppName + " Helper" + (execNameMatch[1] || "");
+        }
+      }
+    }
+  });
+}
+
 exports.patch = function (opts) {
   var pass = es.through();
 
@@ -415,11 +691,16 @@ exports.patch = function (opts) {
     .pipe(patchIcon(opts))
     .pipe(patchInfoPlist(opts))
     .pipe(patchHelperInfoPlist(opts))
+    .pipe(patchMiniAppInfoPlist(opts))
+    .pipe(patchMiniAppHelperInfoPlist(opts))
+    .pipe(patchMiniAppIcon(opts))
     .pipe(createEntitlementsPlist(opts))
     .pipe(addCredits(opts))
     .pipe(moveChromiumLicense(opts))
     .pipe(renameApp(opts))
-    .pipe(renameAppHelper(opts));
+    .pipe(renameAppHelper(opts))
+    .pipe(renameMiniApp(opts))
+    .pipe(renameMiniAppHelper(opts));
 
   return es.duplex(pass, src);
 };

package/src/win32.js

@@ -60,76 +60,113 @@ exports.getAppPath = function (opts) {
   return path.join("resources", "app");
 };
 
+function applyRcedit(f, patch, cb) {
+  var tempPath = temp.path();
+  var ostream = fs.createWriteStream(tempPath);
+
+  f.contents.pipe(ostream);
+  ostream.on("close", function () {
+    // Remove codesignature before editing exe file
+    const signToolPath = getSignTool();
+    const {error} = spawnSync(signToolPath, ["remove", "/s", tempPath]);
+    if (error) {
+      return cb(error);
+    }
+
+    rcedit(tempPath, patch).then(() => {
+      fs.readFile(tempPath, function (err, data) {
+        if (err) {
+          return cb(err);
+        }
+
+        f.contents = data;
+
+        fs.unlink(tempPath, function (err) {
+          if (err) {
+            return cb(err);
+          }
+
+          cb(null, f);
+        });
+      });
+    }).catch(err => {
+      if (err) {
+        return cb(err);
+      }
+    });
+  });
+}
+
 function patchExecutable(opts) {
   return es.map(function (f, cb) {
-    if (
-      f.relative !== getOriginalAppFullName(opts) ||
-      process.platform !== "win32"
-    ) {
+    if (process.platform !== "win32") {
       return cb(null, f);
     }
 
-    var patch = {
-      "version-string": {
-        CompanyName: opts.companyName || "GitHub, Inc.",
-        FileDescription: opts.productAppName || opts.productName,
-        LegalCopyright:
-          opts.copyright ||
-          "Copyright (C) 2014 GitHub, Inc. All rights reserved",
-        ProductName: opts.productAppName || opts.productName,
-        ProductVersion: opts.productVersion,
-      },
-      "file-version": opts.productVersion,
-      "product-version": opts.productVersion,
-    };
-
-    if (opts.createVersionedResources) {
-      if (!opts.productVersionString) {
-        throw new Error("productVersionString must be defined.");
-      }
-      patch["resource-string"] = {
-        2: opts.productVersionString
+    if (f.relative === getOriginalAppFullName(opts)) {
+      var patch = {
+        "version-string": {
+          CompanyName: opts.companyName || "GitHub, Inc.",
+          FileDescription: opts.productAppName || opts.productName,
+          LegalCopyright:
+            opts.copyright ||
+            "Copyright (C) 2014 GitHub, Inc. All rights reserved",
+          ProductName: opts.productAppName || opts.productName,
+          ProductVersion: opts.productVersion,
+        },
+        "file-version": opts.productVersion,
+        "product-version": opts.productVersion,
       };
-    }
 
-    if (opts.winIcon) {
-      patch.icon = opts.winIcon;
+      if (opts.createVersionedResources) {
+        if (!opts.productVersionString) {
+          throw new Error("productVersionString must be defined.");
+        }
+        patch["resource-string"] = {
+          2: opts.productVersionString
+        };
+      }
+
+      if (opts.winIcon) {
+        patch.icon = opts.winIcon;
+      }
+
+      return applyRcedit(f, patch, cb);
     }
 
-    var tempPath = temp.path();
-    var ostream = fs.createWriteStream(tempPath);
+    if (opts.win32ProxyAppName && f.relative === "electron_proxy.exe") {
+      var patch = {
+        "version-string": {
+          CompanyName: opts.companyName || "GitHub, Inc.",
+          FileDescription: opts.win32ProxyAppName,
+          LegalCopyright:
+            opts.copyright ||
+            "Copyright (C) 2014 GitHub, Inc. All rights reserved",
+          ProductName: opts.win32ProxyAppName,
+          ProductVersion: opts.productVersion,
+        },
+        "file-version": opts.productVersion,
+        "product-version": opts.productVersion,
+        "resource-string": {
+          3: `${opts.productName}.exe`
+        },
+      };
 
-    f.contents.pipe(ostream);
-    ostream.on("close", function () {
-      // Remove codesignature before editing exe file
-      const signToolPath = getSignTool();
-      const {error} = spawnSync(signToolPath, ["remove", "/s", tempPath]);
-      if (error) {
-        return cb(error);
+      if (opts.createVersionedResources) {
+        if (!opts.productVersionString) {
+          throw new Error("productVersionString must be defined.");
+        }
+        patch["resource-string"][2] = opts.productVersionString;
       }
 
-      rcedit(tempPath, patch).then(() => {
-        fs.readFile(tempPath, function (err, data) {
-          if (err) {
-            return cb(err);
-          }
-
-          f.contents = data;
+      if (opts.win32ProxyIcon) {
+        patch.icon = opts.win32ProxyIcon;
+      }
 
-          fs.unlink(tempPath, function (err) {
-            if (err) {
-              return cb(err);
-            }
+      return applyRcedit(f, patch, cb);
+    }
 
-            cb(null, f);
-          });
-        });
-      }).catch(err => {
-        if (err) {
-          return cb(err);
-        }
-      });
-    });
+    return cb(null, f);
   });
 }
 
@@ -145,12 +182,12 @@ function removeDefaultApp() {
 
 function renameApp(opts) {
   return rename(function (path) {
-    if (
-      path.dirname === "." &&
-      path.basename === getOriginalAppName(opts) &&
-      path.extname === ".exe"
-    ) {
-      path.basename = opts.productName;
+    if (path.dirname === "." && path.extname === ".exe") {
+      if (path.basename === getOriginalAppName(opts)) {
+        path.basename = opts.productName;
+      } else if (opts.win32ProxyAppName && path.basename === "electron_proxy") {
+        path.basename = opts.win32ProxyAppName;
+      }
     }
   });
 }
@@ -168,6 +205,14 @@ function moveFilesExceptExecutable(opts) {
       return f;
     }
 
+    // Skip if the file is the renamed proxy executable
+    if (
+      opts.win32ProxyAppName &&
+      f.relative === `${opts.win32ProxyAppName}.exe`
+    ) {
+      return f;
+    }
+
     // Move other files to version subfolder
     if (f.path && f.base) {
       const relativePath = path.relative(f.base, f.path);