feat: check that electron-builder version is not outdated for all subcommands

Author: develar

packages/electron-builder/src/builder.ts

@@ -1,15 +1,11 @@
 import BluebirdPromise from "bluebird-lst"
-import { cyan, dim, green, reset, underline } from "chalk"
+import { underline } from "chalk"
 import { Arch, archFromString, DIR_TARGET, Platform } from "electron-builder-core"
 import { CancellationToken } from "electron-builder-http/out/CancellationToken"
 import { addValue, isEmptyOrSpaces } from "electron-builder-util"
 import { warn } from "electron-builder-util/out/log"
-import { executeFinally, printErrorAndExit } from "electron-builder-util/out/promise"
+import { executeFinally } from "electron-builder-util/out/promise"
 import { PublishOptions } from "electron-publish"
-import { readJson } from "fs-extra-p"
-import isCi from "is-ci"
-import * as path from "path"
-import updateNotifier from "update-notifier"
 import { normalizePlatforms, Packager } from "./packager"
 import { PackagerOptions } from "./packagerApi"
 import { PublishManager } from "./publish/PublishManager"
@@ -229,116 +225,93 @@ export function configureBuildCommand(yargs: yargs.Yargs): yargs.Yargs {
     .option("mac", {
       group: buildGroup,
       alias: ["m", "o", "macos"],
-      describe: `Build for macOS, accepts target list (see ${underline("https://goo.gl/HAnnq8")}).`,
+      description: `Build for macOS, accepts target list (see ${underline("https://goo.gl/HAnnq8")}).`,
       type: "array",
     })
     .option("linux", {
       group: buildGroup,
       alias: "l",
-      describe: `Build for Linux, accepts target list (see ${underline("https://goo.gl/O80IL2")})`,
+      description: `Build for Linux, accepts target list (see ${underline("https://goo.gl/O80IL2")})`,
       type: "array",
     })
     .option("win", {
       group: buildGroup,
       alias: ["w", "windows"],
-      describe: `Build for Windows, accepts target list (see ${underline("https://goo.gl/dL4i8i")})`,
+      description: `Build for Windows, accepts target list (see ${underline("https://goo.gl/dL4i8i")})`,
       type: "array",
     })
     .option("x64", {
       group: buildGroup,
-      describe: "Build for x64",
+      description: "Build for x64",
       type: "boolean",
     })
     .option("ia32", {
       group: buildGroup,
-      describe: "Build for ia32",
+      description: "Build for ia32",
       type: "boolean",
     })
     .option("armv7l", {
       group: buildGroup,
-      describe: "Build for armv7l",
+      description: "Build for armv7l",
       type: "boolean",
     })
     .option("dir", {
       group: buildGroup,
-      describe: "Build unpacked dir. Useful to test.",
+      description: "Build unpacked dir. Useful to test.",
       type: "boolean",
     })
     .option("publish", {
       group: publishGroup,
       alias: "p",
-      describe: `Publish artifacts (to GitHub Releases), see ${underline("https://goo.gl/WMlr4n")}`,
+      description: `Publish artifacts (to GitHub Releases), see ${underline("https://goo.gl/WMlr4n")}`,
       choices: ["onTag", "onTagOrDraft", "always", "never", <any>undefined],
     })
     .option("draft", {
       group: publishGroup,
-      describe: "Create a draft (unpublished) release",
+      description: "Create a draft (unpublished) release",
       type: "boolean",
       default: undefined,
     })
     .option("prerelease", {
       group: publishGroup,
-      describe: "Identify the release as a prerelease",
+      description: "Identify the release as a prerelease",
       type: "boolean",
       default: undefined,
     })
     .option("platform", {
       group: deprecated,
-      describe: "The target platform (preferred to use --mac, --win or --linux)",
+      description: "The target platform (preferred to use --mac, --win or --linux)",
       choices: ["mac", "win", "linux", "darwin", "win32", "all", <any>undefined],
     })
     .option("arch", {
       group: deprecated,
-      describe: "The target arch (preferred to use --x64 or --ia32)",
+      description: "The target arch (preferred to use --x64 or --ia32)",
       choices: ["ia32", "x64", "all", <any>undefined],
     })
     .option("extraMetadata", {
       alias: ["em"],
       group: buildGroup,
-      describe: "Inject properties to package.json (asar only)",
+      description: "Inject properties to package.json (asar only)",
     })
     .option("prepackaged", {
       alias: ["pd"],
       group: buildGroup,
-      describe: "The path to prepackaged app (to pack in a distributable format)",
+      description: "The path to prepackaged app (to pack in a distributable format)",
     })
     .option("projectDir", {
       alias: ["project"],
       group: buildGroup,
-      describe: "The path to project directory. Defaults to current working directory.",
+      description: "The path to project directory. Defaults to current working directory.",
     })
     .option("config", {
       alias: ["c"],
       group: buildGroup,
-      describe: "The path to an electron-builder config. Defaults to `electron-builder.yml` (or `json`, or `json5`), see " + underline("https://goo.gl/YFRJOM"),
+      description: "The path to an electron-builder config. Defaults to `electron-builder.yml` (or `json`, or `json5`), see " + underline("https://goo.gl/YFRJOM"),
     })
     .group(["help", "version"], "Other:")
     .example("electron-builder -mwl", "build for macOS, Windows and Linux")
     .example("electron-builder --linux deb tar.xz", "build deb and tar.xz for Linux")
     .example("electron-builder --win --ia32", "build for Windows ia32")
     .example("electron-builder --em.foo=bar", "set package.json property `foo` to `bar`")
     .example("electron-builder --config.nsis.unicode=false", "configure unicode options for NSIS")
-}
-
-/** @private */
-export function buildCommandHandler(args: CliOptions) {
-  if (!isCi && process.env.NO_UPDATE_NOTIFIER == null) {
-    readJson(path.join(__dirname, "..", "..", "package.json"))
-      .then(it => {
-        if (it.version === "0.0.0-semantic-release") {
-          return
-        }
-
-        const notifier = updateNotifier({pkg: it})
-        if (notifier.update != null) {
-          notifier.notify({
-            message: `Update available ${dim(notifier.update.current)}${reset(" → ")}${green(notifier.update.latest)} \nRun ${cyan("npm i electron-builder --save-dev")} to update`
-          })
-        }
-      })
-      .catch(e => warn(`Cannot check updates: ${e}`))
-  }
-
-  build(args)
-    .catch(printErrorAndExit)
 }

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

@@ -1,31 +1,60 @@
 #! /usr/bin/env node
 
-import { underline } from "chalk"
+import { cyan, dim, green, reset, underline } from "chalk"
+import { warn } from "electron-builder-util/out/log"
 import { printErrorAndExit } from "electron-builder-util/out/promise"
+import { readJson } from "fs-extra-p"
+import isCi from "is-ci"
+import * as path from "path"
+import updateNotifier from "update-notifier"
 import yargs from "yargs"
-import { buildCommandHandler, configureBuildCommand } from "../builder"
+import { build, configureBuildCommand } from "../builder"
 import { createSelfSignedCert } from "./create-self-signed-cert"
 import { configureInstallAppDepsCommand, installAppDeps } from "./install-app-deps"
 
 yargs
-  .command(<any>["build", "*"], "Build", configureBuildCommand, buildCommandHandler)
-  .command("install-app-deps", "Install app deps", configureInstallAppDepsCommand, argv => {
-    installAppDeps(argv)
-      .catch(printErrorAndExit)
-  })
+  .command(<any>["build", "*"], "Build", configureBuildCommand, wrap(build))
+  .command("install-app-deps", "Install app deps", configureInstallAppDepsCommand, wrap(installAppDeps))
   .command("create-self-signed-cert", "Create self-signed code signing cert for Windows apps",
     yargs => yargs
       .option("publisher", {
         alias: ["p"],
         type: "string",
         requiresArg: true,
+        description: "The publisher name",
       })
       .demandOption("publisher"),
-    argv => {
-      createSelfSignedCert(argv.publisher)
-        .catch(printErrorAndExit)
-    })
+    wrap(argv => createSelfSignedCert(argv.publisher)))
   .help()
   .epilog(`See the Wiki (${underline("https://github.com/electron-userland/electron-builder/wiki")}) for more documentation.`)
   .strict()
   .argv
+
+function wrap(task: (args: any) => Promise<any>) {
+  return (args: any) => {
+    checkIsOutdated()
+    task(args)
+      .catch(printErrorAndExit)
+  }
+}
+
+function checkIsOutdated() {
+  if (isCi || process.env.NO_UPDATE_NOTIFIER != null) {
+    return
+  }
+
+  readJson(path.join(__dirname, "..", "..", "package.json"))
+    .then(it => {
+      if (it.version === "0.0.0-semantic-release") {
+        return
+      }
+
+      const notifier = updateNotifier({pkg: it})
+      if (notifier.update != null) {
+        notifier.notify({
+          message: `Update available ${dim(notifier.update.current)}${reset(" → ")}${green(notifier.update.latest)} \nRun ${cyan("yarn upgrade electron-builder")} to update`
+        })
+      }
+    })
+    .catch(e => warn(`Cannot check updates: ${e}`))
+}

packages/electron-builder/src/cli/install-app-deps.ts

@@ -2,24 +2,41 @@
 
 import BluebirdPromise from "bluebird-lst"
 import { computeDefaultAppDirectory, use } from "electron-builder-util"
+import { log, warn } from "electron-builder-util/out/log"
 import { printErrorAndExit } from "electron-builder-util/out/promise"
 import yargs from "yargs"
 import { getElectronVersion, loadConfig } from "../util/readPackageJson"
 import { installOrRebuild } from "../yarn"
 
+declare const PACKAGE_VERSION: string
+
+// https://github.com/yargs/yargs/issues/760
+// demandOption is required to be set
 export function configureInstallAppDepsCommand(yargs: yargs.Yargs): yargs.Yargs {
   return yargs
     .option("platform", {
       choices: ["linux", "darwin", "win32"],
       default: process.platform,
+      description: "The target platform",
     })
     .option("arch", {
       choices: ["ia32", "x64", "all"],
       default: process.arch,
+      description: "The target arch",
     })
 }
 
 export async function installAppDeps(args: any) {
+  try {
+    log("electron-builder " + PACKAGE_VERSION)
+  }
+  catch (e) {
+    // error in dev mode without babel
+    if (!(e instanceof ReferenceError)) {
+      throw e
+    }
+  }
+
   const projectDir = process.cwd()
   const config = (await loadConfig(projectDir)) || {}
   const muonVersion = config.muonVersion
@@ -37,6 +54,7 @@ function main() {
 }
 
 if (process.mainModule === module) {
+  warn("Please use as subcommand: electron-builder install-app-deps")
   main()
     .catch(printErrorAndExit)
 }

packages/electron-builder/src/windowsCodeSign.ts

@@ -135,7 +135,7 @@ async function spawnSign(options: SignOptions, inputPath: string, outputPath: st
     args.push(inputPath)
   }
 
-  return await exec(await getToolPath(), args)
+  return await exec(await getToolPath(), args, {timeout: 120 * 1000})
 }
 
 function getOutputPath(inputPath: string, hash: string) {