fix: restore dmg.title support

Closes #834

Author: develar

docs/Options.md

@@ -100,6 +100,7 @@ macOS DMG specific options.
 | icon | <a name="DmgOptions-icon"></a>The path to DMG icon (volume icon), which will be shown when mounted. Defaults to application icon (`build/icon.icns`).
 | iconSize | <a name="DmgOptions-iconSize"></a>The size of all the icons inside the DMG. Defaults to 80.
 | iconTextSize | <a name="DmgOptions-iconTextSize"></a>The size of all the icon texts inside the DMG. Defaults to 12.
+| title | <a name="DmgOptions-title"></a><p>The title of the produced DMG, which will be shown when mounted (volume name). Defaults to <code>${productName} ${version}</code></p> <p>Macro <code>${productName}</code>, <code>${version}</code> and <code>${name}</code> are supported.</p>
 | contents | <a name="DmgOptions-contents"></a>The content — to customize icon locations.
 | format | <a name="DmgOptions-format"></a>The disk image format, one of `UDRW`, `UDRO`, `UDCO`, `UDZO`, `UDBZ`, `ULFO` (lzfse-compressed image (OS X 10.11+ only)). Defaults to `UDBZ` (bzip2-compressed image).
 | window | <a name="DmgOptions-window"></a>The DMG windows position and size. See [.build.dmg.window](#DmgWindow).

src/options/macOptions.ts

@@ -90,6 +90,13 @@ export interface DmgOptions {
    */
   readonly iconTextSize?: number | null
 
+  /*
+  The title of the produced DMG, which will be shown when mounted (volume name). Defaults to `${productName} ${version}`
+
+  Macro `${productName}`, `${version}` and `${name}` are supported.
+   */
+  readonly title?: string | null
+
   /*
   The content — to customize icon locations.
    */

src/targets/dmg.ts

@@ -7,6 +7,7 @@ import BluebirdPromise from "bluebird-lst-c"
 import { debug, use, exec, statOrNull, isEmptyOrSpaces, spawn } from "../util/util"
 import { copy, unlink, outputFile, remove } from "fs-extra-p"
 import { executeFinally } from "../util/promise"
+import sanitizeFileName from "sanitize-filename"
 
 export class DmgTarget extends Target {
   private helperDir = path.join(__dirname, "..", "..", "templates", "dmg")
@@ -41,7 +42,7 @@ export class DmgTarget extends Target {
     // allocate space for .DS_Store
     await outputFile(path.join(backgroundDir, "DSStorePlaceHolder"), new Buffer(preallocatedSize))
 
-    const volumeName = `${appInfo.productFilename} ${appInfo.version}`
+    const volumeName = sanitizeFileName(this.computeVolumeName(specification.title))
     //noinspection SpellCheckingInspection
     await spawn("hdiutil", addVerboseIfNeed(["create",
       "-srcfolder", backgroundDir,
@@ -156,6 +157,18 @@ export class DmgTarget extends Target {
     this.packager.dispatchArtifactCreated(artifactPath, `${appInfo.name}-${appInfo.version}.dmg`)
   }
 
+  computeVolumeName(custom?: string | null): string {
+    const appInfo = this.packager.appInfo
+    if (custom == null) {
+      return `${appInfo.productFilename} ${appInfo.version}`
+    }
+
+    return custom
+      .replace(/\$\{version}/g, appInfo.version)
+      .replace(/\$\{name}/g, appInfo.name)
+      .replace(/\$\{productName}/g, appInfo.productName)
+  }
+
   // public to test
   async computeDmgOptions(): Promise<DmgOptions> {
     const packager = this.packager
@@ -186,15 +199,6 @@ export class DmgTarget extends Target {
       warn("dmg.icon-size is deprecated, please use dmg.iconSize instead")
     }
 
-    if (specification.title != null) {
-      if (specification.title === packager.appInfo.productName) {
-        warn(`Do not specify unnecessary dmg.title ("${specification.title}") — application name ("${packager.appInfo.productFilename}") is used by default`)
-      }
-      else {
-        warn("dmg.title is not supported, file issue if need")
-      }
-    }
-
     if (!("icon" in specification)) {
       use(await packager.getIconPath(), it => {
         specification.icon = it
@@ -262,7 +266,10 @@ export async function attachAndExecute(dmgPath: string, readWrite: boolean, task
   if (readWrite) {
     args.push("-readwrite")
   }
-  addVerboseIfNeed(args)
+
+  // otherwise hangs
+  // addVerboseIfNeed(args)
+
   args.push(dmgPath)
   const attachResult = await exec("hdiutil", args, {maxBuffer: 2 * 1024 * 1024})
   const deviceResult = attachResult == null ? null : /^(\/dev\/\w+)/.exec(attachResult)
@@ -275,7 +282,7 @@ export async function attachAndExecute(dmgPath: string, readWrite: boolean, task
 }
 
 function addVerboseIfNeed(args: Array<string>): Array<string> {
-  if (debug.enabled) {
+  if (process.env.DEBUG_DMG === "true") {
     args.push("-verbose")
   }
   return args

test/src/macPackagerTest.ts

@@ -144,6 +144,7 @@ test.ifOsx("no background", app({
       productName: "Test ß",
       dmg: {
         background: null,
+        title: "Foo",
       },
     }
   }