support for building windows squirrel and msi installers

Fixes #999

Author: starpit

app/main.js

@@ -17,6 +17,9 @@
 const debug = require('debug')('main')
 debug('starting')
 
+// handle squirrel install and update events
+if (require('electron-squirrel-startup')) return
+
 const electron = require('electron'),
       { app } = electron
 

app/package.json

@@ -31,12 +31,13 @@
     "nyc": "^11.3.0"
   },
   "dependencies": {
+    "about-window": "^1.11.0",
     "adm-zip": "^0.4.7",
     "colors": "^1.2.1",
     "columnify": "^1.5.4",
     "debug": "^3.1.0",
-    "about-window": "^1.11.0",
     "electron-editor-context-menu": "^1.1.1",
+    "electron-squirrel-startup": "^1.0.0",
     "es6-promise-pool": "^2.5.0",
     "expand-home-dir": "0.0.3",
     "inquirer": "^3.3.0",

dist/build.sh

@@ -1,20 +1,36 @@
 #!/usr/bin/env bash
 
+#
+# Copyright 2017-2018 IBM Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
 #
 # input params: choose a platform to build for (default: all)
 #
 PLATFORM=${1-all}
 
 # product name
-PRODUCT_NAME="${PRODUCT_NAME-`cat ../app/build/config.json | jq --raw-output .productName`}"
+export PRODUCT_NAME="${PRODUCT_NAME-`cat ../app/build/config.json | jq --raw-output .productName`}"
 
 # filesystem icons
 ICON_MAC=`cat ../app/build/config.json | jq --raw-output .filesystemIcons.darwin`
 ICON_WIN32=`cat ../app/build/config.json | jq --raw-output .filesystemIcons.win32`
 ICON_LINUX=`cat ../app/build/config.json | jq --raw-output .filesystemIcons.linux`
 
 VERSION=`git rev-parse master`
-BUILDDIR=build
+export BUILDDIR=build
 
 # if we're running a test against a dist build, then we need to tell
 # electron-packager to keep around devDependencies
@@ -85,6 +101,10 @@ function win32 {
         #
         if [ -z "$NO_INSTALLER" ]; then
             (cd $BUILDDIR && zip -q -r "${PRODUCT_NAME}-win32-x64" "${PRODUCT_NAME}-win32-x64" -x \*~)
+
+            # build squirrel and msi installers
+            # SETUP_ICON=$ICON_WIN32 node builders/squirrel.js
+            # SETUP_ICON=$ICON_WIN32 node builders/msi.js
         fi
     fi
 }
@@ -151,11 +171,7 @@ function linux {
 
         if [ -z "$NO_INSTALLER" ]; then
             (cd $BUILDDIR && zip -q -r "${PRODUCT_NAME}-linux-x64" "${PRODUCT_NAME}-linux-x64" -x \*~)
-            rm -f "${BUILDDIR}/installers/*.deb"
-            DEBUG=electron-installer-debian ./node_modules/.bin/electron-installer-debian --src "${BUILDDIR}/${PRODUCT_NAME}-linux-x64" --dest ${BUILDDIR}/installers/ --arch amd64 --config dpkg-config.json
-            for deb in "${BUILDDIR}/installers/*.deb"; do
-                mv -f $deb "${BUILDDIR}/${PRODUCT_NAME}-linux-x64.deb"
-            done
+            ./builders/deb.sh
         fi
     fi
 }

dist/builders/deb.sh

@@ -0,0 +1,31 @@
+#!/usr/bin/env bash
+
+#
+# Copyright 2018 IBM Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+# directory of script
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+ROOTDIR="$DIR/.."
+
+cd "$ROOTDIR"
+
+rm -f "${BUILDDIR}/installers/*.deb"
+
+./node_modules/.bin/electron-installer-debian --src "${BUILDDIR}/${PRODUCT_NAME}-linux-x64" --dest ${BUILDDIR}/installers/ --arch amd64 --config dpkg-config.json
+
+for deb in "${BUILDDIR}/installers/*.deb"; do
+    mv -f $deb "${BUILDDIR}/${PRODUCT_NAME}-linux-x64.deb"
+done

dist/builders/msi.js

@@ -0,0 +1,45 @@
+/*
+ * Copyright 2018 IBM Corporation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+const path = require('path')
+const { MSICreator } = require('electron-wix-msi')
+
+const BUILDDIR = path.join(__dirname, '..', process.env.BUILDDIR)
+const { PRODUCT_NAME, SETUP_ICON:setupIcon } = process.env
+
+const appDirectory = path.join(BUILDDIR, `${PRODUCT_NAME}-win32-x64`)
+const outputDirectory = path.join(BUILDDIR, 'installers/win32-x64')
+
+console.log('Windows msi build started')
+
+const creator = new MSICreator({
+    appDirectory,
+    outputDirectory,
+    setupIcon,
+    name: 'fsh',
+    setupExe: `${PRODUCT_NAME}.exe`,
+    exe: 'fsh'
+})
+
+creator.create()
+    .then(() => creator.compile())
+    .then(() => {
+        console.log('Windows msi build succeeded')
+    })
+    .catch(err => {
+        console.error(err)
+        process.exit(1)
+    })

dist/builders/squirrel.js

@@ -0,0 +1,42 @@
+/*
+ * Copyright 2018 IBM Corporation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+const path = require('path')
+const electronInstaller = require('electron-winstaller')
+
+const BUILDDIR = path.join(__dirname, '..', process.env.BUILDDIR)
+const { PRODUCT_NAME, SETUP_ICON:setupIcon } = process.env
+
+const appDirectory = path.join(BUILDDIR, `${PRODUCT_NAME}-win32-x64`)
+const outputDirectory = path.join(BUILDDIR, 'installers/win32-x64')
+
+console.log('Windows squirrel build started')
+
+electronInstaller.createWindowsInstaller({
+    appDirectory,
+    outputDirectory,
+    setupIcon,
+    name: 'fsh',
+    setupExe: `${PRODUCT_NAME}.exe`,
+    exe: 'fsh'
+  })
+    .then(() => {
+        console.log('Windows squirrel build succeeded')
+    })
+    .catch(err => {
+        console.error(err)
+        process.exit(1)
+    })

dist/compile.js

@@ -1,5 +1,21 @@
 #!/usr/bin/env node
 
+/*
+ * Copyright 2017 IBM Corporation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 const compile = require('../app/plugins/modules/plugin/lib/compile'),
       path = require('path')
 

dist/package-lock.json

@@ -5,14 +5,15 @@
   "main": "index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "postinstall": "if [ `uname` == Darwin ]; then brew install fakeroot dpkg; fi"
+    "postinstall": "if [ `uname` == Darwin ]; then brew install fakeroot dpkg mono; fi"
   },
   "author": "",
   "license": "Apache-2.0",
   "devDependencies": {
     "electron-installer-debian": "^0.8.1",
     "electron-installer-dmg": "^0.2.1",
     "electron-packager": "^8.7.2",
+    "electron-wix-msi": "^1.3.0",
     "minifier": "^0.8.1"
   },
   "dependencies": {}