fix(app-builder-lib): macOS packager uses static icon name (#6308)

electron-userland · Oct 3, 2021 · fce1a1f · fce1a1f
1 parent e29a6b8
commit fce1a1f
Show file tree

Hide file tree

Showing 8 changed files with 38 additions and 163 deletions.
diff --git a/.changeset/dirty-walls-burn.md b/.changeset/dirty-walls-burn.md
@@ -0,0 +1,5 @@
+---
+"app-builder-lib": patch
+---
+
+The filename of the app icon in macOS is now always 'icon.icns' instead of a derivate of the product name. The reason for this change is that macOS doesn't display icons with non-ASCII characters in their names, which is quite possible in languages other than English.
diff --git a/packages/app-builder-lib/src/macPackager.ts b/packages/app-builder-lib/src/macPackager.ts
@@ -396,7 +396,7 @@ export default class MacPackager extends PlatformPackager<MacConfiguration> {
       if (oldIcon != null) {
         await unlinkIfExists(path.join(resourcesPath, oldIcon))
       }
-      const iconFileName = `${appFilename}.icns`
+      const iconFileName = "icon.icns"
       appPlist.CFBundleIconFile = iconFileName
       await copyFile(icon, path.join(resourcesPath, iconFileName))
     }

diff --git a/test/snapshots/PublishManagerTest.js.snap b/test/snapshots/PublishManagerTest.js.snap
@@ -162,7 +162,7 @@ exports[`generic, github and spaces 2`] = `
 Object {
   "CFBundleDisplayName": "Test App ßW",
   "CFBundleExecutable": "Test App ßW",
-  "CFBundleIconFile": "Test App ßW.icns",
+  "CFBundleIconFile": "icon.icns",
   "CFBundleIdentifier": "org.electron-builder.testApp",
   "CFBundleInfoDictionaryVersion": "6.0",
   "CFBundleName": "Test App ßW",
@@ -289,7 +289,7 @@ exports[`mac artifactName  2`] = `
 Object {
   "CFBundleDisplayName": "Test App ßW",
   "CFBundleExecutable": "Test App ßW",
-  "CFBundleIconFile": "Test App ßW.icns",
+  "CFBundleIconFile": "icon.icns",
   "CFBundleIdentifier": "org.electron-builder.testApp",
   "CFBundleInfoDictionaryVersion": "6.0",
   "CFBundleName": "Test App ßW",
@@ -366,7 +366,7 @@ exports[`os macro 2`] = `
 Object {
   "CFBundleDisplayName": "Test App ßW",
   "CFBundleExecutable": "Test App ßW",
-  "CFBundleIconFile": "Test App ßW.icns",
+  "CFBundleIconFile": "icon.icns",
   "CFBundleIdentifier": "org.electron-builder.testApp",
   "CFBundleInfoDictionaryVersion": "6.0",
   "CFBundleName": "Test App ßW",

diff --git a/test/snapshots/mac/dmgTest.js.snap b/test/snapshots/mac/dmgTest.js.snap
@@ -35,7 +35,7 @@ exports[`background color 3`] = `
 Object {
   "CFBundleDisplayName": "BackgroundColor",
   "CFBundleExecutable": "BackgroundColor",
-  "CFBundleIconFile": "BackgroundColor.icns",
+  "CFBundleIconFile": "icon.icns",
   "CFBundleIdentifier": "org.electron-builder.testApp",
   "CFBundleInfoDictionaryVersion": "6.0",
   "CFBundleName": "BackgroundColor",
@@ -94,7 +94,7 @@ exports[`bundleShortVersion 2`] = `
 Object {
   "CFBundleDisplayName": "BundleShortVersion",
   "CFBundleExecutable": "BundleShortVersion",
-  "CFBundleIconFile": "BundleShortVersion.icns",
+  "CFBundleIconFile": "icon.icns",
   "CFBundleIdentifier": "org.electron-builder.testApp",
   "CFBundleInfoDictionaryVersion": "6.0",
   "CFBundleName": "BundleShortVersion",
@@ -148,7 +148,7 @@ exports[`custom background - new way 2`] = `
 Object {
   "CFBundleDisplayName": "Test App ßW",
   "CFBundleExecutable": "Test App ßW",
-  "CFBundleIconFile": "Test App ßW.icns",
+  "CFBundleIconFile": "icon.icns",
   "CFBundleIdentifier": "org.electron-builder.testApp",
   "CFBundleInfoDictionaryVersion": "6.0",
   "CFBundleName": "Test App ßW",
@@ -202,7 +202,7 @@ exports[`disable dmg icon (light), bundleVersion 2`] = `
 Object {
   "CFBundleDisplayName": "Test App ßW",
   "CFBundleExecutable": "Test App ßW",
-  "CFBundleIconFile": "Test App ßW.icns",
+  "CFBundleIconFile": "icon.icns",
   "CFBundleIdentifier": "org.electron-builder.testApp",
   "CFBundleInfoDictionaryVersion": "6.0",
   "CFBundleName": "Test App ßW",
@@ -261,7 +261,7 @@ exports[`dmg 2`] = `
 Object {
   "CFBundleDisplayName": "DefaultDmg",
   "CFBundleExecutable": "DefaultDmg",
-  "CFBundleIconFile": "DefaultDmg.icns",
+  "CFBundleIconFile": "icon.icns",
   "CFBundleIdentifier": "org.electron-builder.testApp",
   "CFBundleInfoDictionaryVersion": "6.0",
   "CFBundleName": "DefaultDmg",
@@ -380,7 +380,7 @@ exports[`license buttons config 3`] = `
 Object {
   "CFBundleDisplayName": "Test App ßW",
   "CFBundleExecutable": "Test App ßW",
-  "CFBundleIconFile": "Test App ßW.icns",
+  "CFBundleIconFile": "icon.icns",
   "CFBundleIdentifier": "org.electron-builder.testApp",
   "CFBundleInfoDictionaryVersion": "6.0",
   "CFBundleName": "Test App ßW",
@@ -441,7 +441,7 @@ exports[`license en 2`] = `
 Object {
   "CFBundleDisplayName": "Test App ßW",
   "CFBundleExecutable": "Test App ßW",
-  "CFBundleIconFile": "Test App ßW.icns",
+  "CFBundleIconFile": "icon.icns",
   "CFBundleIdentifier": "org.electron-builder.testApp",
   "CFBundleInfoDictionaryVersion": "6.0",
   "CFBundleName": "Test App ßW",
@@ -502,7 +502,7 @@ exports[`license ja 2`] = `
 Object {
   "CFBundleDisplayName": "Test App ßW",
   "CFBundleExecutable": "Test App ßW",
-  "CFBundleIconFile": "Test App ßW.icns",
+  "CFBundleIconFile": "icon.icns",
   "CFBundleIdentifier": "org.electron-builder.testApp",
   "CFBundleInfoDictionaryVersion": "6.0",
   "CFBundleName": "Test App ßW",
@@ -563,7 +563,7 @@ exports[`license rtf 2`] = `
 Object {
   "CFBundleDisplayName": "Test App ßW",
   "CFBundleExecutable": "Test App ßW",
-  "CFBundleIconFile": "Test App ßW.icns",
+  "CFBundleIconFile": "icon.icns",
   "CFBundleIdentifier": "org.electron-builder.testApp",
   "CFBundleInfoDictionaryVersion": "6.0",
   "CFBundleName": "Test App ßW",
@@ -624,7 +624,7 @@ exports[`multi language license 2`] = `
 Object {
   "CFBundleDisplayName": "Test App ßW",
   "CFBundleExecutable": "Test App ßW",
-  "CFBundleIconFile": "Test App ßW.icns",
+  "CFBundleIconFile": "icon.icns",
   "CFBundleIdentifier": "org.electron-builder.testApp",
   "CFBundleInfoDictionaryVersion": "6.0",
   "CFBundleName": "Test App ßW",
@@ -707,7 +707,7 @@ exports[`no Applications link 3`] = `
 Object {
   "CFBundleDisplayName": "NoApplicationsLink",
   "CFBundleExecutable": "NoApplicationsLink",
-  "CFBundleIconFile": "NoApplicationsLink.icns",
+  "CFBundleIconFile": "icon.icns",
   "CFBundleIdentifier": "org.electron-builder.testApp",
   "CFBundleInfoDictionaryVersion": "6.0",
   "CFBundleName": "NoApplicationsLink",
@@ -766,7 +766,7 @@ exports[`no background 2`] = `
 Object {
   "CFBundleDisplayName": "NoBackground",
   "CFBundleExecutable": "NoBackground",
-  "CFBundleIconFile": "NoBackground.icns",
+  "CFBundleIconFile": "icon.icns",
   "CFBundleIdentifier": "org.electron-builder.testApp",
   "CFBundleInfoDictionaryVersion": "6.0",
   "CFBundleName": "NoBackground",
@@ -894,7 +894,7 @@ exports[`retina background as 2 png 2`] = `
 Object {
   "CFBundleDisplayName": "Test App ßW",
   "CFBundleExecutable": "Test App ßW",
-  "CFBundleIconFile": "Test App ßW.icns",
+  "CFBundleIconFile": "icon.icns",
   "CFBundleIdentifier": "org.electron-builder.testApp",
   "CFBundleInfoDictionaryVersion": "6.0",
   "CFBundleName": "Test App ßW",
@@ -955,7 +955,7 @@ exports[`unset dmg icon 2`] = `
 Object {
   "CFBundleDisplayName": "Test ß No Volume Icon",
   "CFBundleExecutable": "Test ß No Volume Icon",
-  "CFBundleIconFile": "Test ß No Volume Icon.icns",
+  "CFBundleIconFile": "icon.icns",
   "CFBundleIdentifier": "org.electron-builder.testApp",
   "CFBundleInfoDictionaryVersion": "6.0",
   "CFBundleName": "Test ß No Volume Icon",

diff --git a/test/snapshots/mac/macArchiveTest.js.snap b/test/snapshots/mac/macArchiveTest.js.snap
@@ -16,7 +16,7 @@ exports[`empty installLocation 2`] = `
 Object {
   "CFBundleDisplayName": "Test App ßW",
   "CFBundleExecutable": "Test App ßW",
-  "CFBundleIconFile": "Test App ßW.icns",
+  "CFBundleIconFile": "icon.icns",
   "CFBundleIdentifier": "org.electron-builder.testApp",
   "CFBundleInfoDictionaryVersion": "6.0",
   "CFBundleName": "Test App ßW",
@@ -77,7 +77,7 @@ exports[`extraDistFiles 2`] = `
 Object {
   "CFBundleDisplayName": "Test App ßW",
   "CFBundleExecutable": "Test App ßW",
-  "CFBundleIconFile": "Test App ßW.icns",
+  "CFBundleIconFile": "icon.icns",
   "CFBundleIdentifier": "org.electron-builder.testApp",
   "CFBundleInfoDictionaryVersion": "6.0",
   "CFBundleName": "Test App ßW",
@@ -159,7 +159,7 @@ exports[`only zip 2`] = `
 Object {
   "CFBundleDisplayName": "Test App ßW",
   "CFBundleExecutable": "Test App ßW",
-  "CFBundleIconFile": "Test App ßW.icns",
+  "CFBundleIconFile": "icon.icns",
   "CFBundleIdentifier": "org.electron-builder.testApp",
   "CFBundleInfoDictionaryVersion": "6.0",
   "CFBundleName": "Test App ßW",
@@ -208,7 +208,7 @@ exports[`pkg 2`] = `
 Object {
   "CFBundleDisplayName": "Test App ßW",
   "CFBundleExecutable": "Test App ßW",
-  "CFBundleIconFile": "Test App ßW.icns",
+  "CFBundleIconFile": "icon.icns",
   "CFBundleIdentifier": "org.electron-builder.testApp",
   "CFBundleInfoDictionaryVersion": "6.0",
   "CFBundleName": "Test App ßW",
@@ -257,7 +257,7 @@ exports[`pkg extended configuration 2`] = `
 Object {
   "CFBundleDisplayName": "Test App ßW",
   "CFBundleExecutable": "Test App ßW",
-  "CFBundleIconFile": "Test App ßW.icns",
+  "CFBundleIconFile": "icon.icns",
   "CFBundleIdentifier": "org.electron-builder.testApp",
   "CFBundleInfoDictionaryVersion": "6.0",
   "CFBundleName": "Test App ßW",
@@ -306,7 +306,7 @@ exports[`pkg scripts 2`] = `
 Object {
   "CFBundleDisplayName": "Test App ßW",
   "CFBundleExecutable": "Test App ßW",
-  "CFBundleIconFile": "Test App ßW.icns",
+  "CFBundleIconFile": "icon.icns",
   "CFBundleIdentifier": "org.electron-builder.testApp",
   "CFBundleInfoDictionaryVersion": "6.0",
   "CFBundleName": "Test App ßW",
@@ -405,7 +405,7 @@ Array [
   "Test App ßW.app/Contents/Resources/sw.lproj",
   "Test App ßW.app/Contents/Resources/ta.lproj",
   "Test App ßW.app/Contents/Resources/te.lproj",
-  "Test App ßW.app/Contents/Resources/Test App ßW.icns",
+  "Test App ßW.app/Contents/Resources/icon.icns",
   "Test App ßW.app/Contents/Resources/th.lproj",
   "Test App ßW.app/Contents/Resources/tr.lproj",
   "Test App ßW.app/Contents/Resources/uk.lproj",
@@ -791,7 +791,7 @@ exports[`tar.gz 2`] = `
 Object {
   "CFBundleDisplayName": "Test App ßW",
   "CFBundleExecutable": "Test App ßW",
-  "CFBundleIconFile": "Test App ßW.icns",
+  "CFBundleIconFile": "icon.icns",
   "CFBundleIdentifier": "org.electron-builder.testApp",
   "CFBundleInfoDictionaryVersion": "6.0",
   "CFBundleName": "Test App ßW",

diff --git a/test/snapshots/mac/macPackagerTest.js.snap b/test/snapshots/mac/macPackagerTest.js.snap
@@ -254,7 +254,7 @@ exports[`two-package 2`] = `
 Object {
   "CFBundleDisplayName": "TestApp",
   "CFBundleExecutable": "TestApp",
-  "CFBundleIconFile": "TestApp.icns",
+  "CFBundleIconFile": "icon.icns",
   "CFBundleIdentifier": "org.electron-builder.testApp",
   "CFBundleInfoDictionaryVersion": "6.0",
   "CFBundleName": "TestApp",
@@ -289,7 +289,7 @@ Object {
 
 exports[`two-package 3`] = `
 Array [
-  "TestApp.icns",
+  "icon.icns",
   "app-update.yml",
   "app.asar",
   "bn.lproj",
@@ -301,7 +301,7 @@ exports[`two-package 4`] = `
 Object {
   "CFBundleDisplayName": "TestApp",
   "CFBundleExecutable": "TestApp",
-  "CFBundleIconFile": "TestApp.icns",
+  "CFBundleIconFile": "icon.icns",
   "CFBundleIdentifier": "org.electron-builder.testApp",
   "CFBundleInfoDictionaryVersion": "6.0",
   "CFBundleName": "TestApp",
@@ -336,7 +336,7 @@ Object {
 
 exports[`two-package 5`] = `
 Array [
-  "TestApp.icns",
+  "icon.icns",
   "app-update.yml",
   "app.asar",
   "bn.lproj",
@@ -348,7 +348,7 @@ exports[`two-package 6`] = `
 Object {
   "CFBundleDisplayName": "TestApp",
   "CFBundleExecutable": "TestApp",
-  "CFBundleIconFile": "TestApp.icns",
+  "CFBundleIconFile": "icon.icns",
   "CFBundleIdentifier": "org.electron-builder.testApp",
   "CFBundleInfoDictionaryVersion": "6.0",
   "CFBundleName": "TestApp",
@@ -383,7 +383,7 @@ Object {
 
 exports[`two-package 7`] = `
 Array [
-  "TestApp.icns",
+  "icon.icns",
   "app-update.yml",
   "app.asar",
   "bn.lproj",

diff --git a/test/snapshots/protonTest.js.snap b/test/snapshots/protonTest.js.snap
@@ -45,7 +45,7 @@ exports[`mac 2`] = `
 Object {
   "CFBundleDisplayName": "Test App ßW",
   "CFBundleExecutable": "Test App ßW",
-  "CFBundleIconFile": "Test App ßW.icns",
+  "CFBundleIconFile": "icon.icns",
   "CFBundleIdentifier": "org.electron-builder.testApp",
   "CFBundleName": "Test App ßW",
   "CFBundleShortVersionString": "1.1.0",