feat: add support for CFBundleIconName (#37)

* feat: add support for CFBundleIconName

* chore: separate option for miniapp

* chore: fix tests

Author: deepak1556

README.md

@@ -102,6 +102,8 @@ The following options are **optional**:
 - **Darwin**
 
   - `darwinIcon` - path to an `.icns` file
+  - `darwinAssetsCar` - path to an `Assets.car` file for the main app
+  - `darwinMiniAppAssetsCar` - path to an `Assets.car` file for the miniapp (requires `darwinMiniAppName`)
   - `darwinHelpBookFolder` - the `CFBundleHelpBookFolder` value
   - `darwinHelpBookName` - the `CFBundleHelpBookName` value
   - `darwinBundleDocumentTypes` - ([reference](https://developer.apple.com/library/ios/documentation/filemanagement/conceptual/documentinteraction_topicsforios/Articles/RegisteringtheFileTypesYourAppSupports.html)) array of dictionaries, each containing the following structure:

package-lock.json

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

package.json

@@ -87,6 +87,63 @@ function patchIcon(opts) {
   return es.duplex(pass, es.merge(src, icon));
 }
 
+function patchAssetsCar(opts) {
+  if (!opts.darwinAssetsCar) {
+    return es.through();
+  }
+
+  var assetsCarPath = path.join(
+    getOriginalAppFullName(opts),
+    "Contents",
+    "Resources",
+    "Assets.car"
+  );
+  var pass = es.through();
+
+  // Filter out the existing Assets.car so the provided one replaces it.
+  var src = pass.pipe(
+    es.mapSync(function (f) {
+      if (f.relative !== assetsCarPath) {
+        return f;
+      }
+    })
+  );
+
+  var assets = vfs.src(opts.darwinAssetsCar).pipe(rename(assetsCarPath));
+
+  return es.duplex(pass, es.merge(src, assets));
+}
+
+function patchMiniAppAssetsCar(opts) {
+  if (!opts.darwinMiniAppName || !opts.darwinMiniAppAssetsCar) {
+    return es.through();
+  }
+
+  var assetsCarPath = path.join(
+    getOriginalAppFullName(opts),
+    "Contents",
+    "Applications",
+    getOriginalMiniAppFullName(opts),
+    "Contents",
+    "Resources",
+    "Assets.car"
+  );
+  var pass = es.through();
+
+  // Filter out the existing Assets.car so the provided one replaces it.
+  var src = pass.pipe(
+    es.mapSync(function (f) {
+      if (f.relative !== assetsCarPath) {
+        return f;
+      }
+    })
+  );
+
+  var assets = vfs.src(opts.darwinMiniAppAssetsCar).pipe(rename(assetsCarPath));
+
+  return es.duplex(pass, es.merge(src, assets));
+}
+
 function patchInfoPlist(opts) {
   var contentsPath = path.join(getOriginalAppFullName(opts), "Contents");
   var resourcesPath = path.join(contentsPath, "Resources");
@@ -113,6 +170,7 @@ function patchInfoPlist(opts) {
 
       f.contents.on("end", function () {
         var infoPlist = plist.parse(contents.toString("utf8"));
+        var iconName = opts.productName || "AppIcon";
 
         opts.darwinBundleIdentifier &&
           (infoPlist["CFBundleIdentifier"] = opts.darwinBundleIdentifier);
@@ -127,6 +185,7 @@ function patchInfoPlist(opts) {
         opts.copyright &&
           (infoPlist["NSHumanReadableCopyright"] = opts.copyright);
         infoPlist["CFBundleIconFile"] = opts.productName + ".icns";
+        infoPlist["CFBundleIconName"] = iconName;
 
         if (opts.darwinExecutable) {
           infoPlist["CFBundleExecutable"] = opts.darwinExecutable;
@@ -326,6 +385,7 @@ function patchMiniAppInfoPlist(opts) {
         var infoPlist = plist.parse(contents.toString("utf8"));
 
         var miniAppName = getMiniAppName(opts);
+        var iconName = miniAppName || "AppIcon";
 
         // Bundle identifier
         if (opts.darwinMiniAppBundleIdentifier) {
@@ -349,6 +409,7 @@ function patchMiniAppInfoPlist(opts) {
         if (opts.darwinMiniAppIcon) {
           infoPlist["CFBundleIconFile"] = path.basename(opts.darwinMiniAppIcon);
         }
+        infoPlist["CFBundleIconName"] = iconName;
 
         // Copyright
         if (opts.copyright) {
@@ -702,11 +763,13 @@ exports.patch = function (opts) {
   var src = pass
     .pipe(opts.keepDefaultApp ? es.through() : removeDefaultApp(opts))
     .pipe(patchIcon(opts))
+    .pipe(patchAssetsCar(opts))
     .pipe(patchInfoPlist(opts))
     .pipe(patchHelperInfoPlist(opts))
     .pipe(patchMiniAppInfoPlist(opts))
     .pipe(patchMiniAppHelperInfoPlist(opts))
     .pipe(patchMiniAppIcon(opts))
+    .pipe(patchMiniAppAssetsCar(opts))
     .pipe(createEntitlementsPlist(opts))
     .pipe(addCredits(opts))
     .pipe(moveChromiumLicense(opts))

src/darwin.js

@@ -0,0 +1,126 @@
+"use strict";
+
+var assert = require("assert");
+var path = require("path");
+var es = require("event-stream");
+var File = require("vinyl");
+var darwin = require("../src/darwin");
+
+function runPatch(opts, inputFiles, cb) {
+  var files = {};
+
+  es.readArray(inputFiles)
+    .pipe(darwin.patch(opts))
+    .on("data", function (f) {
+      files[f.relative] = f;
+    })
+    .on("error", cb)
+    .on("end", function () {
+      cb(null, files);
+    });
+}
+
+function createFile(relativePath, contents) {
+  return new File({
+    cwd: process.cwd(),
+    base: process.cwd(),
+    path: path.join(process.cwd(), relativePath),
+    contents: Buffer.from(contents, "utf8"),
+  });
+}
+
+var describeDarwin = process.platform === "darwin" ? describe : describe.skip;
+
+describeDarwin("darwin patch", function () {
+  it("should use separate assets options for app and miniapp", function (cb) {
+    var mainAssetsPath = path.join(__dirname, "fixtures", "AssetsMain.car");
+    var miniAssetsPath = path.join(__dirname, "fixtures", "AssetsMini.car");
+
+    var mainTarget = path.join(
+      "Electron.app",
+      "Contents",
+      "Resources",
+      "Assets.car"
+    );
+    var miniTarget = path.join(
+      "Electron.app",
+      "Contents",
+      "Applications",
+      "Electron MiniApp.app",
+      "Contents",
+      "Resources",
+      "Assets.car"
+    );
+
+    runPatch(
+      {
+        version: "35.0.0",
+        productName: "Electron",
+        productVersion: "1.0.0",
+        darwinMiniAppName: "Electron MiniApp",
+        darwinAssetsCar: mainAssetsPath,
+        darwinMiniAppAssetsCar: miniAssetsPath,
+      },
+      [
+        createFile(mainTarget, "old-main"),
+        createFile(miniTarget, "old-mini"),
+      ],
+      function (err, files) {
+        if (err) {
+          return cb(err);
+        }
+
+        assert(files[mainTarget]);
+        assert(files[miniTarget]);
+        assert.equal(files[mainTarget].contents.toString("utf8"), "main-assets-car\n");
+        assert.equal(files[miniTarget].contents.toString("utf8"), "mini-assets-car\n");
+        cb();
+      }
+    );
+  });
+
+  it("should not patch miniapp assets when only darwinAssetsCar is provided", function (cb) {
+    var mainAssetsPath = path.join(__dirname, "fixtures", "AssetsMain.car");
+
+    var mainTarget = path.join(
+      "Electron.app",
+      "Contents",
+      "Resources",
+      "Assets.car"
+    );
+    var miniTarget = path.join(
+      "Electron.app",
+      "Contents",
+      "Applications",
+      "Electron MiniApp.app",
+      "Contents",
+      "Resources",
+      "Assets.car"
+    );
+
+    runPatch(
+      {
+        version: "35.0.0",
+        productName: "Electron",
+        productVersion: "1.0.0",
+        darwinMiniAppName: "Electron MiniApp",
+        darwinAssetsCar: mainAssetsPath,
+      },
+      [
+        createFile(mainTarget, "old-main"),
+        createFile(miniTarget, "old-mini"),
+      ],
+      function (err, files) {
+        if (err) {
+          return cb(err);
+        }
+
+        assert(files[mainTarget]);
+        assert(files[miniTarget]);
+        assert.equal(files[mainTarget].contents.toString("utf8"), "main-assets-car\n");
+        assert.equal(files[miniTarget].contents.toString("utf8"), "old-mini");
+        cb();
+      }
+    );
+  });
+});

test/darwin.test.js

@@ -0,0 +1 @@
+main-assets-car

test/fixtures/AssetsMain.car

@@ -0,0 +1 @@
+mini-assets-car

test/fixtures/AssetsMini.car

@@ -114,6 +114,7 @@ describe("electron", function () {
           var infoPlist = plist.parse(files[infoPlistPath].contents.toString("utf8"));
           assert.equal(infoPlist["CFBundleName"], "FakeTemplateApp")
           assert.equal(infoPlist["CFBundleDisplayName"], "FakeTemplateApp")
+          assert.equal(infoPlist["CFBundleIconName"], "FakeTemplateApp")
 
           // Added helper Info.plist validation
           var helperBasePath = path.join(