feat(pkg): pkg license

Close #1547, Close #2212
electron-userland · Oct 30, 2017 · a0cb477 · a0cb477
1 parent e574db8
commit a0cb477
Show file tree

Hide file tree

Showing 6 changed files with 39 additions and 14 deletions.
diff --git a/packages/builder-util/src/api.ts b/packages/builder-util/src/api.ts
@@ -8,4 +8,6 @@ export interface PackageBuilder {
   readonly resourceList: Promise<Array<string>>
 
   getTempFile(suffix: string): Promise<string>
+
+  getResource(custom: string | null | undefined, ...names: Array<string>): Promise<string | null>
 }
diff --git a/packages/builder-util/src/license.ts b/packages/builder-util/src/license.ts
@@ -23,6 +23,20 @@ export function getLicenseAssets(fileNames: Array<string>, packager: PackageBuil
     })
 }
 
+export async function getNotLocalizedLicenseFiles(custom: string | null | undefined, packager: PackageBuilder): Promise<string | null> {
+  const possibleFiles: Array<string> = []
+  for (const name of ["license", "eula"]) {
+    for (const ext of ["rtf", "txt", "html"]) {
+      possibleFiles.push(`${name}.${ext}`)
+      possibleFiles.push(`${name.toUpperCase()}.${ext}`)
+      possibleFiles.push(`${name}.${ext.toUpperCase()}`)
+      possibleFiles.push(`${name.toUpperCase()}.${ext.toUpperCase()}`)
+    }
+  }
+
+  return await packager.getResource(custom, ...possibleFiles)
+}
+
 export async function getLicenseFiles(packager: PackageBuilder): Promise<Array<LicenseFile>> {
   return getLicenseAssets((await packager.resourceList)
     .filter(it => {

diff --git a/packages/electron-builder/src/options/macOptions.ts b/packages/electron-builder/src/options/macOptions.ts
@@ -137,6 +137,11 @@ export interface PkgOptions extends TargetSpecificOptions {
    * The name of certificate to use when signing. Consider using environment variables [CSC_LINK or CSC_NAME](../code-signing.md) instead of specifying this option.
    */
   readonly identity?: string | null
+
+  /**
+   * The path to EULA license file. Defaults to `license.txt` or `eula.txt` (or uppercase variants). In addition to `txt, `rtf` and `html` supported (don't forget to use `target="_blank"` for links).
+   */
+  readonly license?: string | null
 }
 
 export interface DmgOptions extends TargetSpecificOptions {

diff --git a/packages/electron-builder/src/targets/nsis/nsisLicense.ts b/packages/electron-builder/src/targets/nsis/nsisLicense.ts
@@ -1,23 +1,13 @@
 import { lcid } from "builder-util/out/langs"
-import { getLicenseFiles } from "builder-util/out/license"
+import { getLicenseFiles, getNotLocalizedLicenseFiles } from "builder-util/out/license"
 import * as path from "path"
 import { WinPackager } from "../../winPackager"
 import { NsisOptions } from "./nsisOptions"
 import { NsisScriptGenerator } from "./nsisScriptGenerator"
 import { nsisTemplatesDir } from "./nsisUtil"
 
 export async function computeLicensePage(packager: WinPackager, options: NsisOptions, scriptGenerator: NsisScriptGenerator, languages: Array<string>): Promise<void> {
-  const possibleFiles: Array<string> = []
-  for (const name of ["license", "eula"]) {
-    for (const ext of ["rtf", "txt", "html"]) {
-      possibleFiles.push(`${name}.${ext}`)
-      possibleFiles.push(`${name.toUpperCase()}.${ext}`)
-      possibleFiles.push(`${name}.${ext.toUpperCase()}`)
-      possibleFiles.push(`${name.toUpperCase()}.${ext.toUpperCase()}`)
-    }
-  }
-
-  const license = await packager.getResource(options.license, ...possibleFiles)
+  const license = await getNotLocalizedLicenseFiles(options.license, packager)
   if (license != null) {
     let licensePage: Array<string>
     if (license.endsWith(".html")) {

diff --git a/packages/electron-builder/src/targets/pkg.ts b/packages/electron-builder/src/targets/pkg.ts
@@ -8,6 +8,7 @@ import { Target } from "../core"
 import MacPackager from "../macPackager"
 import { PkgOptions } from "../options/macOptions"
 import { filterCFBundleIdentifier } from "../packager/mac"
+import { getNotLocalizedLicenseFiles } from "builder-util/out/license"
 
 const certType = "Developer ID Installer"
 
@@ -19,7 +20,9 @@ export class PkgTarget extends Target {
   readonly options: PkgOptions = {
     allowAnywhere: true,
     allowCurrentUserHome: true,
-    allowRootDirectory: true, ...this.packager.config.pkg}
+    allowRootDirectory: true,
+    ...this.packager.config.pkg,
+  }
 
   constructor(private readonly packager: MacPackager, readonly outDir: string) {
     super("pkg")
@@ -70,6 +73,12 @@ export class PkgTarget extends Target {
     let distInfo = await readFile(distInfoFile, "utf-8")
     const insertIndex = distInfo.lastIndexOf("</installer-gui-script>")
     distInfo = distInfo.substring(0, insertIndex) + `    <domains enable_anywhere="${options.allowAnywhere}" enable_currentUserHome="${options.allowCurrentUserHome}" enable_localSystem="${options.allowRootDirectory}" />\n` + distInfo.substring(insertIndex)
+
+    const license = await getNotLocalizedLicenseFiles(options.license, this.packager)
+    if (license != null) {
+      distInfo = distInfo.substring(0, insertIndex) + `    <license file="${license}"/>\n` + distInfo.substring(insertIndex)
+    }
+
     debug(distInfo)
     await writeFile(distInfoFile, distInfo)
   }

diff --git a/test/src/mac/macArchiveTest.ts b/test/src/mac/macArchiveTest.ts
@@ -6,7 +6,7 @@ import { readFile, symlink } from "fs-extra-p"
 import * as path from "path"
 import pathSorter from "path-sort"
 import { assertThat } from "../helpers/fileAssert"
-import { app, createMacTargetTest, getFixtureDir, parseFileList } from "../helpers/packTester"
+import { app, copyTestAsset, createMacTargetTest, getFixtureDir, parseFileList } from "../helpers/packTester"
 
 test.ifMac("invalid target", () => assertThat(createMacTargetTest(["ttt" as any])()).throws())
 
@@ -27,6 +27,11 @@ test.ifAll.ifMac("empty installLocation", app({
   }
 }, {
   signed: false,
+  projectDirCreated: projectDir => {
+    return BluebirdPromise.all([
+      copyTestAsset("license.txt", path.join(projectDir, "build", "license.txt")),
+    ])
+  },
 }))
 
 test.ifAll.ifMac("pkg scripts", app({