feat(nsis): artifact file name pattern

Close electron-userland#1221, electron-userland#1219

docs/Auto Update.md

@@ -86,7 +86,7 @@ Emitted when there is no available update.
   * `total`
   * `transferred`
 
-Emitted on progress. Only supported over Windows build, since `Squirrel.Mac` does not provide this data.
+Emitted on progress. Only supported over Windows build, since `Squirrel.Mac` [does not provide](https://github.com/electron-userland/electron-builder/issues/1167) this data.
 
 #### Event: `update-downloaded`
 

docs/Options.md

@@ -178,6 +178,7 @@ See [NSIS target notes](https://github.com/electron-userland/electron-builder/wi
 | language | <a name="NsisOptions-language"></a>* [LCID Dec](https://msdn.microsoft.com/en-au/goglobal/bb964664.aspx), defaults to `1033`(`English - United States`).
 | warningsAsErrors | <a name="NsisOptions-warningsAsErrors"></a>Defaults to `true`. If `warningsAsErrors` is `true` (default): NSIS will treat warnings as errors. If `warningsAsErrors` is `false`: NSIS will allow warnings.
 | menuCategory | <a name="NsisOptions-menuCategory"></a>Whether to create submenu for start menu shortcut and program files directory. Defaults to `false`. If `true`, company name will be used. Or string value.
+| artifactName | <a name="NsisOptions-artifactName"></a><p>The artifact file name pattern. Defaults to <code>${productName} Setup ${version}.${ext}</code>. <code>${name}</code>, <code>${productName}</code>, <code>${version}</code>, <code>${ext}</code>, <code>${arch}</code>, <code>${os}</code> (expanded to <code>mac</code>, <code>linux</code> or <code>win</code> according to current platform) macro are supported.</p> <p>If no <code>arch</code>, macro will be removed from your pattern with leading space, <code>-</code> or <code>_</code> (so, you don’t need to worry and can reuse pattern).</p>
 
 <a name="Protocol"></a>
 ### `protocols` URL Protocol Schemes

package.json

@@ -25,7 +25,7 @@
     "7zip-bin": "^2.0.4",
     "archiver": "^1.3.0",
     "asar-electron-builder": "^0.13.5",
-    "aws-sdk": "^2.9.0",
+    "aws-sdk": "^2.10.0",
     "bluebird-lst-c": "^1.0.6",
     "chalk": "^1.1.3",
     "chromium-pickle-js": "^0.2.0",

packages/electron-builder-publisher/readme.md

@@ -1,5 +1,7 @@
-# electron-publisher-s3
+# electron-builder-publisher
 
 Part of [electron-builder](https://github.com/electron-userland/electron-builder). 
 
-See the [Publishing Artifacts.](https://github.com/electron-userland/electron-builder/wiki/Publishing-Artifacts) section of the [Wiki](https://github.com/electron-userland/electron-builder/wiki) for more information.
+See the [Publishing Artifacts](https://github.com/electron-userland/electron-builder/wiki/Publishing-Artifacts) section of the [Wiki](https://github.com/electron-userland/electron-builder/wiki) for more information.
+
+Can be used standalone.

packages/electron-builder-publisher/src/gitHubPublisher.ts

@@ -42,7 +42,7 @@ export class GitHubPublisher extends HttpPublisher {
   }
 
   constructor(context: PublishContext, private readonly info: GithubOptions, private readonly version: string, private readonly options: PublishOptions = {}) {
-    super(context)
+    super(context, true)
 
     let token = info.token
     if (isEmptyOrSpaces(token)) {

packages/electron-builder-publisher/src/publisher.ts

@@ -33,7 +33,7 @@ export abstract class Publisher {
 
   abstract get providerName(): string
 
-  abstract upload(file: string, artifactName?: string): Promise<any>
+  abstract upload(file: string, safeArtifactName?: string): Promise<any>
 
   protected createProgressBar(fileName: string, fileStat: Stats): ProgressBar | null {
     if (this.context.progress == null) {
@@ -63,12 +63,12 @@ export abstract class Publisher {
 }
 
 export abstract class HttpPublisher extends Publisher {
-  constructor(protected readonly context: PublishContext) {
+  constructor(protected readonly context: PublishContext, private readonly useSafeArtifactName = false) {
     super(context)
   }
 
-  async upload(file: string, artifactName?: string): Promise<any> {
-    const fileName = artifactName || basename(file)
+  async upload(file: string, safeArtifactName?: string): Promise<any> {
+    const fileName = (this.useSafeArtifactName ? safeArtifactName : null) || basename(file)
     const fileStat = await stat(file)
 
     const progressBar = this.createProgressBar(fileName, fileStat)

packages/electron-builder-squirrel-windows/src/squirrelWindows.ts

@@ -6,9 +6,9 @@ import { buildInstaller, convertVersion, SquirrelOptions } from "./squirrelPack"
 import { SquirrelWindowsOptions } from "electron-builder/out/options/winOptions"
 import { Target, Arch, getArchSuffix } from "electron-builder-core"
 
-const SW_VERSION = "1.5.1.4"
+const SW_VERSION = "1.5.2.0"
 //noinspection SpellCheckingInspection
-const SW_SHA2 = "30caa74802259f956d7b73f4b282917c10c6dd3d29f5ca3e4d996b2896f2aa0d"
+const SW_SHA2 = "e96a109d4641ebb85d163eaefe7770b165ebc25d1cc77c5179f021b232fc3730"
 
 export default class SquirrelWindowsTarget extends Target {
   private readonly options: SquirrelWindowsOptions = Object.assign({}, this.packager.platformSpecificBuildOptions, this.packager.config.squirrelWindows)

packages/electron-builder/src/errorMessages.ts

@@ -1,28 +1,7 @@
-export const buildIsMissed = `Please specify 'build' configuration in the development package.json ('%s'), at least
-
-  build: {
-    "appId": "your.id",
-    "category": "your.app.category.type"
-  }
-}
-
-is required.
-`
-
 export const authorEmailIsMissed = `Please specify author 'email' in the application package.json
 
 See https://docs.npmjs.com/files/package.json#people-fields-author-contributors
 
 It is required to set Linux .deb package maintainer. Or you can set maintainer in the custom linux options.
 (see https://github.com/electron-userland/electron-builder#distributable-format-configuration).
-`
-
-export const buildInAppSpecified = `'build' in the application package.json ('%s') is not supported since 3.0 anymore
-
-Please move 'build' into the development package.json ('%s')
-`
-
-export const nameInBuildSpecified = `'name' in the 'build' is forbidden.
-
-Please move 'name' from 'build' into the application package.json ('%s')
 `

packages/electron-builder/src/options/winOptions.ts

@@ -145,6 +145,13 @@ export interface NsisOptions {
 
   // defaults to false
   readonly useZip?: boolean
+
+  /*
+  The artifact file name pattern. Defaults to `${productName} Setup ${version}.${ext}`. `${name}`, `${productName}`, `${version}`, `${ext}`, `${arch}`, `${os}` (expanded to `mac`, `linux` or `win` according to current platform) macro are supported.
+
+  If no `arch`, macro will be removed from your pattern with leading space, `-` or `_` (so, you don't need to worry and can reuse pattern).
+   */
+  readonly artifactName?: string | null
 }
 
 /*

packages/electron-builder/src/packager.ts

@@ -9,9 +9,7 @@ import { TmpDir } from "electron-builder-util/out/tmp"
 import { EventEmitter } from "events"
 import * as path from "path"
 import { lt as isVersionLessThan } from "semver"
-import * as util from "util"
 import { AppInfo } from "./appInfo"
-import * as errorMessages from "./errorMessages"
 import MacPackager from "./macPackager"
 import { AfterPackContext, Config, Metadata } from "./metadata"
 import { ArtifactCreated, BuildInfo, PackagerOptions, SourceRepositoryInfo } from "./packagerApi"
@@ -273,8 +271,9 @@ export class Packager implements BuildInfo {
   }
 
   private checkMetadata(appPackageFile: string, devAppPackageFile: string): void {
+    const errors: Array<string> = []
     const reportError = (missedFieldName: string) => {
-      throw new Error(`Please specify '${missedFieldName}' in the application package.json ('${appPackageFile}')`)
+      errors.push(`Please specify '${missedFieldName}' in the application package.json ('${appPackageFile}')`)
     }
 
     const checkNotEmpty = (name: string, value: string | n) => {
@@ -289,45 +288,44 @@ export class Packager implements BuildInfo {
     checkNotEmpty("description", appMetadata.description)
     checkNotEmpty("version", appMetadata.version)
 
-    checkDependencies(this.devMetadata.dependencies)
+    checkDependencies(this.devMetadata.dependencies, errors)
     if ((<any>appMetadata) !== this.devMetadata) {
-      checkDependencies(appMetadata.dependencies)
+      checkDependencies(appMetadata.dependencies, errors)
 
       if ((<any>appMetadata).build != null) {
-        throw new Error(util.format(errorMessages.buildInAppSpecified, appPackageFile, devAppPackageFile))
+        errors.push(`'build' in the application package.json (${appPackageFile}) is not supported since 3.0 anymore. Please move 'build' into the development package.json (${devAppPackageFile})`)
       }
     }
 
-    const build = <any>this.config
-    if (build == null) {
-      throw new Error(util.format(errorMessages.buildIsMissed, devAppPackageFile))
+    const config = <any>this.config
+    if (config["osx-sign"] != null) {
+      errors.push("osx-sign is deprecated and not supported — please see https://github.com/electron-userland/electron-builder/wiki/Code-Signing")
+    }
+    if (config["osx"] != null) {
+      errors.push(`osx is deprecated and not supported — please use mac instead`)
+    }
+    if (config["app-copyright"] != null) {
+      errors.push(`app-copyright is deprecated and not supported — please use copyright instead`)
+    }
+    if (config["app-category-type"] != null) {
+      errors.push(`app-category-type is deprecated and not supported — please use mac.category instead`)
     }
-    else {
-      if (build["osx-sign"] != null) {
-        throw new Error("osx-sign is deprecated and not supported — please see https://github.com/electron-userland/electron-builder/wiki/Code-Signing")
-      }
-      if (build["osx"] != null) {
-        throw new Error(`build.osx is deprecated and not supported — please use build.mac instead`)
-      }
-      if (build["app-copyright"] != null) {
-        throw new Error(`build.app-copyright is deprecated and not supported — please use build.copyright instead`)
-      }
-      if (build["app-category-type"] != null) {
-        throw new Error(`build.app-category-type is deprecated and not supported — please use build.mac.category instead`)
-      }
 
-      const author = appMetadata.author
-      if (author == null) {
-        throw new Error(`Please specify "author" in the application package.json ('${appPackageFile}') — it is used as company name.`)
-      }
+    const author = appMetadata.author
+    if (author == null) {
+      errors.push(`Please specify "author" in the application package.json ('${appPackageFile}') — it is used as company name and copyright owner.`)
+    }
 
-      if (build.name != null) {
-        throw new Error(util.format(errorMessages.nameInBuildSpecified, appPackageFile))
-      }
+    if (config.name != null) {
+      errors.push(`'name' in the config is forbidden. Please move 'name' into the package.json (${appPackageFile})`)
+    }
 
-      if (build.prune != null) {
-        warn("prune is deprecated — development dependencies are never copied in any case")
-      }
+    if (config.prune != null) {
+      errors.push("prune is deprecated — development dependencies are never copied in any case")
+    }
+
+    if (errors.length > 0) {
+      throw new Error(errors.join("\n"))
     }
   }
 
@@ -450,14 +448,14 @@ export async function checkWineVersion(checkPromise: Promise<string>) {
   }
 }
 
-function checkDependencies(dependencies?: { [key: string]: string }) {
+function checkDependencies(dependencies: { [key: string]: string } | null | undefined, errors: Array<string>) {
   if (dependencies == null) {
     return
   }
 
   for (const name of ["electron", "electron-prebuilt", "electron-builder"]) {
     if (name in dependencies) {
-      throw new Error(`Package "${name}" is only allowed in "devDependencies". `
+      errors.push(`Package "${name}" is only allowed in "devDependencies". `
         + `Please remove it from the "dependencies" section in your package.json.`)
     }
   }

packages/electron-builder/src/packagerApi.ts

@@ -73,7 +73,7 @@ export interface ArtifactCreated {
   readonly file?: string
   readonly data?: Buffer
 
-  readonly artifactName?: string
+  readonly safeArtifactName?: string
 
   readonly publishConfig?: PublishConfiguration
 }

packages/electron-builder/src/platformPackager.ts

@@ -84,10 +84,10 @@ export abstract class PlatformPackager<DC extends PlatformSpecificBuildOptions>
     return this.packagerOptions.prepackaged || path.join(outDir, `${this.platform.buildConfigurationKey}${getArchSuffix(arch)}${this.platform === Platform.MAC ? "" : "-unpacked"}`)
   }
 
-  dispatchArtifactCreated(file: string, target: Target | null, artifactName?: string) {
+  dispatchArtifactCreated(file: string, target: Target | null, safeArtifactName?: string) {
     this.info.dispatchArtifactCreated({
       file: file,
-      artifactName: artifactName,
+      safeArtifactName: safeArtifactName,
       packager: this,
       target: target,
     })
@@ -394,6 +394,46 @@ export abstract class PlatformPackager<DC extends PlatformSpecificBuildOptions>
     await this.checkFileInPackage(resourcesDir, "package.json", "Application", isAsar)
   }
 
+  expandArtifactNamePattern(pattern: string, ext: string, arch: Arch | null): string {
+    let p = pattern
+    if (arch == null) {
+      p = p
+        .replace("-${arch}", "")
+        .replace(" ${arch}", "")
+        .replace("_${arch}", "")
+    }
+
+    const appInfo = this.appInfo
+    return p.replace(/\$\{([a-zA-Z]+)\}/g, (match, p1): string => {
+      switch (p1) {
+        case "name":
+          return appInfo.name
+
+        case "version":
+          return appInfo.version
+
+        case "productName":
+          return appInfo.productFilename
+
+        case "arch":
+          if (arch == null) {
+            // see above, we remove macro if no arch
+            return ""
+          }
+          return Arch[arch]
+
+        case "os":
+          return this.platform.name
+
+        case "ext":
+          return ext
+
+        default:
+          throw new Error(`Macro ${p1} is not defined`)
+      }
+    })
+  }
+
   generateName(ext: string | null, arch: Arch, deployment: boolean, classifier: string | null = null): string {
     let c: string | null = null
     let e: string | null = null

packages/electron-builder/src/publish/PublishManager.ts

@@ -104,10 +104,10 @@ export class PublishManager implements PublishContext {
         const publisher = this.getOrCreatePublisher(publishConfig, packager.info)
         if (publisher != null) {
           if (event.file == null) {
-            this.addTask((<HttpPublisher>publisher).uploadData(event.data!, event.artifactName!))
+            this.addTask((<HttpPublisher>publisher).uploadData(event.data!, event.safeArtifactName!))
           }
           else {
-            this.addTask(publisher.upload(event.file!, event.artifactName))
+            this.addTask(publisher.upload(event.file!, event.safeArtifactName))
           }
         }
       }
@@ -246,7 +246,7 @@ async function writeUpdateInfo(event: ArtifactCreated, _publishConfigs: Array<Pu
             path: githubArtifactName,
             sha2: sha2,
           })),
-          artifactName: `${channel}.yml`,
+          safeArtifactName: `${channel}.yml`,
           packager: packager,
           target: null,
           publishConfig: githubPublishConfig,
@@ -310,22 +310,22 @@ export function getPublishConfigs(packager: PlatformPackager<any>, targetSpecifi
     publishers = targetSpecificOptions.publish
     // if explicitly set to null - do not publish
     if (publishers === null) {
-      return null
+      return BluebirdPromise.resolve(null)
     }
   }
 
   // check build.win (platform)
   if (publishers == null) {
     publishers = packager.platformSpecificBuildOptions.publish
     if (publishers === null) {
-      return null
+      return BluebirdPromise.resolve(null)
     }
   }
 
   if (publishers == null) {
     publishers = packager.config.publish
     if (publishers === null) {
-      return null
+      return BluebirdPromise.resolve(null)
     }
 
     if (publishers == null) {

packages/electron-builder/src/targets/nsis.ts

@@ -72,8 +72,8 @@ export default class NsisTarget extends Target {
     const packager = this.packager
     const appInfo = packager.appInfo
     const version = appInfo.version
-    const installerFilename = `${appInfo.productFilename} Setup ${version}.exe`
     const options = this.options
+    const installerFilename = packager.expandArtifactNamePattern(options.artifactName || "${productName} Setup ${version}.${ext}", "exe", null)
     const iconPath = await packager.getResource(options.installerIcon, "installerIcon.ico") || await packager.getIconPath()
     const oneClick = options.oneClick !== false
 

packages/electron-publisher-s3/package.json

@@ -12,7 +12,7 @@
   ],
   "dependencies": {
     "fs-extra-p": "^3.1.0",
-    "aws-sdk": "^2.9.0",
+    "aws-sdk": "^2.10.0",
     "mime": "^1.3.4",
     "bluebird-lst-c": "^1.0.6",
     "electron-builder-publisher": "~0.0.0-semantic-release",

packages/electron-publisher-s3/readme.md

@@ -2,4 +2,6 @@
 
 Part of [electron-builder](https://github.com/electron-userland/electron-builder). 
 
-See the [Publishing Artifacts.](https://github.com/electron-userland/electron-builder/wiki/Publishing-Artifacts) section of the [Wiki](https://github.com/electron-userland/electron-builder/wiki) for more information.
+See the [Publishing Artifacts](https://github.com/electron-userland/electron-builder/wiki/Publishing-Artifacts) section of the [Wiki](https://github.com/electron-userland/electron-builder/wiki) for more information.
+
+Can be used standalone.

packages/electron-publisher-s3/src/s3Publisher.ts

@@ -26,8 +26,8 @@ export default class S3Publisher extends Publisher {
   }
 
   // http://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/s3-example-creating-buckets.html
-  async upload(file: string, artifactName?: string): Promise<any> {
-    const fileName = artifactName || basename(file)
+  async upload(file: string, safeArtifactName?: string): Promise<any> {
+    const fileName = basename(file)
     const fileStat = await stat(file)
     return this.context.cancellationToken.trackPromise(new BluebirdPromise((resolve, reject, onCancel) => {
       //noinspection JSUnusedLocalSymbols