feat(osx): Optional DMG background

develar · develar · commit 4088b13dbeef · 2016-05-17T07:59:27.000+02:00
diff --git a/.idea/dictionaries/develar.xml b/.idea/dictionaries/develar.xml
diff --git a/docs/Options.md b/docs/Options.md
@@ -69,7 +69,7 @@ See all [appdmg options](https://www.npmjs.com/package/appdmg#json-specification
 | Name | Description
 | --- | ---
 | icon | <a name="OsXBuildOptions-icon"></a>The path to icon, which will be shown when mounted (default: `build/icon.icns`).
-| background | <a name="OsXBuildOptions-background"></a>The path to background (default: `build/background.png`). The resolution of this file determines the resolution of the installer window.
+| background | <a name="OsXBuildOptions-background"></a><p>The path to background (default: <code>build/background.png</code> if exists). The resolution of this file determines the resolution of the installer window. If background is not specified, use <code>window.size</code>, see [specification](https://github.com/LinusU/node-appdmg#json-specification)).</p>
 | target | <a name="OsXBuildOptions-target"></a>Target package type: list of `default`, `dmg`, `zip`, `mas`, `7z`. Defaults to `default` (dmg and zip for Squirrel.Mac).
 | identity | <a name="OsXBuildOptions-identity"></a><p>The name of certificate to use when signing. Consider using environment variables [CSC_LINK or CSC_NAME](https://github.com/electron-userland/electron-builder/wiki/Code-Signing). MAS installer identity is specified in the [.build.mas](#MasBuildOptions-identity).</p>
 | entitlements | <a name="OsXBuildOptions-entitlements"></a><p>The path to entitlements file for signing the app. <code>build/osx.entitlements</code> will be used if exists (it is a recommended way to set). MAS entitlements is specified in the [.build.mas](#MasBuildOptions-entitlements).</p>
diff --git a/package.json b/package.json
@@ -81,7 +81,7 @@
     "tmp": "0.0.28"
   },
   "optionalDependencies": {
-    "appdmg-tf": "^0.3.11"
+    "appdmg": "^0.4.2"
   },
   "config": {
     "pre-git": {
diff --git a/src/metadata.ts b/src/metadata.ts
@@ -153,7 +153,8 @@ export interface OsXBuildOptions extends PlatformSpecificBuildOptions {
   readonly icon?: string | null
 
   /*
-   The path to background (default: `build/background.png`). The resolution of this file determines the resolution of the installer window.
+   The path to background (default: `build/background.png` if exists). The resolution of this file determines the resolution of the installer window.
+   If background is not specified, use `window.size`, see [specification](https://github.com/LinusU/node-appdmg#json-specification).
    */
   readonly background?: string | null
 
diff --git a/src/osxPackager.ts b/src/osxPackager.ts
@@ -164,7 +164,8 @@ export default class OsXPackager extends PlatformPackager<OsXBuildOptions> {
         {
           "x": 130, "y": 220, "type": "file"
         }
-      ]
+      ],
+      format: this.devMetadata.build.compression === "store" ? "UDRO" : "UDBZ",
     }, this.customBuildOptions)
 
     if (!("background" in this.customBuildOptions)) {
@@ -190,14 +191,13 @@ export default class OsXPackager extends PlatformPackager<OsXBuildOptions> {
           target: artifactPath,
           basepath: this.projectDir,
           specification: await this.computeEffectiveDistOptions(appOutDir),
-          compression: this.devMetadata.build.compression === "store" ? "NONE" : "UDBZ"
         }
 
         if (debug.enabled) {
           debug(`appdmg: ${JSON.stringify(dmgOptions, <any>null, 2)}`)
         }
 
-        const emitter = require("appdmg-tf")(dmgOptions)
+        const emitter = require("appdmg")(dmgOptions)
         emitter.on("error", reject)
         emitter.on("finish", () => resolve())
         if (debug.enabled) {
diff --git a/test/src/osxPackagerTest.ts b/test/src/osxPackagerTest.ts
@@ -2,7 +2,7 @@ import test from "./helpers/avaEx"
 import { assertPack, platform, modifyPackageJson, signed } from "./helpers/packTester"
 import { Platform } from "out"
 import OsXPackager from "out/osxPackager"
-import { move, writeFile } from "fs-extra-p"
+import { move, writeFile, deleteFile } from "fs-extra-p"
 import * as path from "path"
 import { BuildInfo, PackagerOptions } from "out/platformPackager"
 import { Promise as BluebirdPromise } from "bluebird"
@@ -135,9 +135,9 @@ test.ifOsx("entitlements in build dir", () => {
   })
 })
 
-// test.ifOsx("no background", (t: any) => assertPack("test-app-one", platform(Platform.OSX), {
-//   tempDirCreated: projectDir => deleteFile(path.join(projectDir, "build", "background.png"))
-// }))
+test.ifOsx("no background", (t: any) => assertPack("test-app-one", platform(Platform.OSX), {
+  tempDirCreated: projectDir => deleteFile(path.join(projectDir, "build", "background.png"))
+}))
 
 test.ifOsx("custom background", () => {
   let platformPackager: CheckingOsXPackager = null
diff --git a/typings/appdmg.d.ts b/typings/appdmg.d.ts
@@ -15,7 +15,7 @@ declare namespace appdmg {
   }
 }
 
-declare module "appdmg-tf" {
+declare module "appdmg" {
   import { EventEmitter } from "events"
 
   function appdmg(options: appdmg.Options): EventEmitter

Original file line number	Diff line number	Diff line change
`@@ -164,7 +164,8 @@ export default class OsXPackager extends PlatformPackager<OsXBuildOptions> {`
`164`	`164`	`{`
`165`	`165`	`"x": 130, "y": 220, "type": "file"`
`166`	`166`	`}`
`167`		`- ]`
	`167`	`+ ],`
	`168`	`+ format: this.devMetadata.build.compression === "store" ? "UDRO" : "UDBZ",`
`168`	`169`	`}, this.customBuildOptions)`
`169`	`170`
`170`	`171`	`if (!("background" in this.customBuildOptions)) {`
`@@ -190,14 +191,13 @@ export default class OsXPackager extends PlatformPackager<OsXBuildOptions> {`
`190`	`191`	`target: artifactPath,`
`191`	`192`	`basepath: this.projectDir,`
`192`	`193`	`specification: await this.computeEffectiveDistOptions(appOutDir),`
`193`		`- compression: this.devMetadata.build.compression === "store" ? "NONE" : "UDBZ"`
`194`	`194`	`}`
`195`	`195`
`196`	`196`	`if (debug.enabled) {`
`197`	`197`	debug(`appdmg: ${JSON.stringify(dmgOptions, <any>null, 2)}`)
`198`	`198`	`}`
`199`	`199`
`200`		`- const emitter = require("appdmg-tf")(dmgOptions)`
	`200`	`+ const emitter = require("appdmg")(dmgOptions)`
`201`	`201`	`emitter.on("error", reject)`
`202`	`202`	`emitter.on("finish", () => resolve())`
`203`	`203`	`if (debug.enabled) {`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ declare namespace appdmg {`
`15`	`15`	`}`
`16`	`16`	`}`
`17`	`17`
`18`		`-declare module "appdmg-tf" {`
	`18`	`+declare module "appdmg" {`
`19`	`19`	`import { EventEmitter } from "events"`
`20`	`20`
`21`	`21`	`function appdmg(options: appdmg.Options): EventEmitter`