fix(AppImage): AppImage artifact name does not use artifactName tem…

…plate Close #1726
electron-userland · Jun 22, 2017 · a02fbd7 · a02fbd7
1 parent 6f8b94b
commit a02fbd7
Show file tree

Hide file tree

Showing 7 changed files with 18 additions and 8 deletions.
diff --git a/docs/Options.md b/docs/Options.md
@@ -374,7 +374,7 @@ Configuration Options
 
     If list contains `default`, it will be replaced to default list, so, `["default", "foo"]` can be used to add custom parts `foo` in addition to defaults.
   * <a name="SnapOptions-ubuntuAppPlatformContent"></a>`ubuntuAppPlatformContent` String - Specify `ubuntu-app-platform1` to use [ubuntu-app-platform](https://insights.ubuntu.com/2016/11/17/how-to-create-snap-packages-on-qt-applications/). Snap size will be greatly reduced, but it is not recommended for now because "the snaps must be connected before running uitk-gallery for the first time".
-* <a name="Config-appimage"></a>`appimage` [LinuxTargetSpecificOptions](electron-builder#LinuxTargetSpecificOptions)
+* <a name="Config-appImage"></a>`appImage` [LinuxTargetSpecificOptions](electron-builder#LinuxTargetSpecificOptions)
 * <a name="Config-pacman"></a>`pacman` [LinuxTargetSpecificOptions](electron-builder#LinuxTargetSpecificOptions)
 * <a name="Config-rpm"></a>`rpm` [LinuxTargetSpecificOptions](electron-builder#LinuxTargetSpecificOptions)
 * <a name="Config-freebsd"></a>`freebsd` [LinuxTargetSpecificOptions](electron-builder#LinuxTargetSpecificOptions)

diff --git a/docs/api/electron-builder.md b/docs/api/electron-builder.md
@@ -67,6 +67,7 @@
 
 | Name | Type |
 | --- | --- |
+| **outDir**| <code>String</code> | 
 | **appOutDir**| <code>String</code> | 
 | **packager**| <code>[PlatformPackager](#PlatformPackager)&lt;any&gt;</code> | 
 | **electronPlatformName**| <code>String</code> | 
@@ -106,7 +107,6 @@
 | **repositoryInfo**| <code>Promise&lt; \| [SourceRepositoryInfo](#SourceRepositoryInfo)&gt;</code> | 
 | **isPrepackedAppAsar**| <code>Boolean</code> | 
 | **cancellationToken**| <code>[CancellationToken](electron-builder-http#CancellationToken)</code> | 
-| **outDir**| <code>String</code> | 
 
 
 * [`.BuildInfo`](#BuildInfo)
@@ -224,7 +224,6 @@
 | tempDirManager = <code>new TmpDir()</code>| <code>module:electron-builder-util/out/tmp.TmpDir</code> | 
 | options| <code>[PackagerOptions](Options#PackagerOptions)</code> | 
 | **repositoryInfo**| <code>Promise&lt; \| [SourceRepositoryInfo](#SourceRepositoryInfo)&gt;</code> | 
-| **outDir**| <code>String</code> | 
 
 
 * [.Packager](#Packager) ⇐ <code>[BuildInfo](#BuildInfo)</code>
@@ -793,9 +792,13 @@
 ## electron-builder/out/util/flags
 
 * [electron-builder/out/util/flags](#module_electron-builder/out/util/flags)
+    * [`.isBuildCacheEnabled()`](#module_electron-builder/out/util/flags.isBuildCacheEnabled) ⇒ <code>Boolean</code>
     * [`.isUseSystemSigncode()`](#module_electron-builder/out/util/flags.isUseSystemSigncode) ⇒ <code>Boolean</code>
     * [`.isUseSystemWine()`](#module_electron-builder/out/util/flags.isUseSystemWine) ⇒ <code>Boolean</code>
 
+<a name="module_electron-builder/out/util/flags.isBuildCacheEnabled"></a>
+### `electron-builder/out/util/flags.isBuildCacheEnabled()` ⇒ <code>Boolean</code>
+**Kind**: method of [<code>electron-builder/out/util/flags</code>](#module_electron-builder/out/util/flags)  
 <a name="module_electron-builder/out/util/flags.isUseSystemSigncode"></a>
 ### `electron-builder/out/util/flags.isUseSystemSigncode()` ⇒ <code>Boolean</code>
 **Kind**: method of [<code>electron-builder/out/util/flags</code>](#module_electron-builder/out/util/flags)  

diff --git a/packages/electron-builder/src/metadata.ts b/packages/electron-builder/src/metadata.ts
@@ -298,7 +298,7 @@ export interface Config extends PlatformSpecificBuildOptions {
    * [Snap](http://snapcraft.io) options.
    */
   readonly snap?: SnapOptions | null
-  readonly appimage?: LinuxTargetSpecificOptions | null
+  readonly appImage?: LinuxTargetSpecificOptions | null
   readonly pacman?: LinuxTargetSpecificOptions | null
   readonly rpm?: LinuxTargetSpecificOptions | null
   readonly freebsd?: LinuxTargetSpecificOptions | null

diff --git a/packages/electron-builder/src/targets/appImage.ts b/packages/electron-builder/src/targets/appImage.ts
@@ -35,7 +35,8 @@ export default class AppImageTarget extends Target {
     const packager = this.packager
 
     // /~https://github.com/electron-userland/electron-builder/issues/775
-    const resultFile = path.join(this.outDir, packager.computeSafeArtifactName("AppImage", arch, false))
+    // /~https://github.com/electron-userland/electron-builder/issues/1726
+    const resultFile = path.join(this.outDir, this.options.artifactName == null ? packager.computeSafeArtifactName("AppImage", arch, false) : packager.expandArtifactNamePattern(this.options, "AppImage", arch))
     await unlinkIfExists(resultFile)
 
     const appImagePath = await appImagePathPromise
@@ -98,6 +99,6 @@ export default class AppImageTarget extends Target {
 
     await chmod(resultFile, "0755")
 
-    packager.dispatchArtifactCreated(resultFile, this, arch)
+    packager.dispatchArtifactCreated(resultFile, this, arch, packager.computeSafeArtifactName("AppImage", arch, false))
   }
 }
diff --git a/packages/electron-builder/src/targets/pkg.ts b/packages/electron-builder/src/targets/pkg.ts
@@ -58,7 +58,7 @@ export class PkgTarget extends Target {
     })
     await BluebirdPromise.all([unlink(innerPackageFile), unlink(distInfoFile)])
 
-    packager.dispatchArtifactCreated(outFile, this, arch, `${appInfo.name}-${appInfo.version}.pkg`)
+    packager.dispatchArtifactCreated(outFile, this, arch, packager.computeSafeArtifactName("pkg", arch))
   }
 
   private async customizeDistributionConfiguration(distInfoFile: string, appPath: string) {

diff --git a/test/out/linux/__snapshots__/linuxPackagerTest.js.snap b/test/out/linux/__snapshots__/linuxPackagerTest.js.snap
@@ -18,7 +18,8 @@ Object {
   "linux": Array [
     Object {
       "arch": 1,
-      "file": "TestApp-1.1.0-x86_64.AppImage",
+      "file": "boo-Test App ßW",
+      "safeArtifactName": "TestApp-1.1.0-x86_64.AppImage",
     },
   ],
 }
@@ -30,6 +31,7 @@ Object {
     Object {
       "arch": 1,
       "file": "TestApp-1.1.0-x86_64.AppImage",
+      "safeArtifactName": "TestApp-1.1.0-x86_64.AppImage",
     },
   ],
 }
@@ -41,6 +43,7 @@ Object {
     Object {
       "arch": 1,
       "file": "TestApp-1.1.0-x86_64.AppImage",
+      "safeArtifactName": "TestApp-1.1.0-x86_64.AppImage",
     },
   ],
 }

diff --git a/test/src/linux/linuxPackagerTest.ts b/test/src/linux/linuxPackagerTest.ts
@@ -16,6 +16,9 @@ test.ifDevOrLinuxCi("AppImage - default icon, custom executable and custom deskt
         Foo: "bar",
         Terminal: "true",
       },
+    },
+    appImage: {
+      artifactName: "boo-${productName}",
     }
   },
   effectiveOptionComputed: async (it) => {