implement electron-builder support, remove electron-packager

Author: GregorBiswanger

ElectronNET.CLI/Commands/Actions/DeployEmbeddedElectronFiles.cs

@@ -8,6 +8,7 @@ public static void Do(string tempPath)
         {
             EmbeddedFileHelper.DeployEmbeddedFile(tempPath, "main.js");
             EmbeddedFileHelper.DeployEmbeddedFile(tempPath, "package.json");
+            EmbeddedFileHelper.DeployEmbeddedFile(tempPath, "build-helper.js");
 
             string hostApiFolder = Path.Combine(tempPath, "api");
             if (Directory.Exists(hostApiFolder) == false)

ElectronNET.CLI/Commands/BuildCommand.cs

@@ -105,19 +105,19 @@ public Task<bool> ExecuteAsync()
                 Console.WriteLine("Start npm install...");
                 ProcessHelper.CmdExecute("npm install --production", tempPath);
 
-                Console.WriteLine("Start npm install electron-packager...");
+                Console.WriteLine("Start npm install electron-builder...");
 
                 if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
 
                 {
                     // Works proper on Windows... 
-                    ProcessHelper.CmdExecute("npm install electron-packager --global", tempPath);
+                    ProcessHelper.CmdExecute("npm install electron-builder --global", tempPath);
                 }
                 else
                 {
                     // ToDo: find another solution or document it proper
                     // GH Issue https://github.com/electron-userland/electron-prebuilt/issues/48
-                    Console.WriteLine("Electron Packager - make sure you invoke 'sudo npm install electron-packager --global' at " + tempPath + " manually. Sry.");
+                    Console.WriteLine("Electron Builder - make sure you invoke 'sudo npm install electron-builder --global' at " + tempPath + " manually. Sry.");
                 }
 
                 Console.WriteLine("ElectronHostHook handling started...");
@@ -132,9 +132,11 @@ public Task<bool> ExecuteAsync()
                     Console.WriteLine("Start npm install for hosthooks...");
                     ProcessHelper.CmdExecute("npm install --production", hosthookDir);
 
-                    string tscPath = Path.Combine(tempPath, "node_modules", ".bin");
+                    // ToDo: Global TypeScript installation is needed for ElectronHostHook
+                    //string tscPath = Path.Combine(tempPath, "node_modules", ".bin");
+                    
                     // ToDo: Not sure if this runs under linux/macos
-                    ProcessHelper.CmdExecute(@"tsc -p ../../ElectronHostHook --sourceMap false", tscPath);
+                    ProcessHelper.CmdExecute(@"tsc -p . --sourceMap false", hosthookDir);
                 }
 
                 Console.WriteLine("Build Electron Desktop Application...");
@@ -166,15 +168,17 @@ public Task<bool> ExecuteAsync()
                     electronParams = parser.Arguments[_paramElectronParams][0];
                 }
 
+                // ToDo: Make the same thing easer with native c# - we can save a tmp file in production code :)
+                Console.WriteLine("Create electron-builder configuration file...");
+                ProcessHelper.CmdExecute($"node build-helper.js", tempPath);
+
                 Console.WriteLine($"Package Electron App for Platform {platformInfo.ElectronPackerPlatform}...");
-                ProcessHelper.CmdExecute($"electron-packager . --platform={platformInfo.ElectronPackerPlatform} --arch={electronArch} {electronParams} --out=\"{buildPath}\" --overwrite", tempPath);
+                ProcessHelper.CmdExecute($"electron-builder . --config=./bin/electron-builder.json --platform={platformInfo.ElectronPackerPlatform} --arch={electronArch} {electronParams}", tempPath);
 
                 Console.WriteLine("... done");
 
                 return true;
             });
         }
-
-
     }
 }

ElectronNET.CLI/Commands/StartElectronCommand.cs

@@ -1,6 +1,5 @@
 using System;
 using System.Collections.Generic;
-using System.Diagnostics;
 using System.IO;
 using System.Runtime.InteropServices;
 using System.Threading.Tasks;

ElectronNET.CLI/ElectronNET.CLI.csproj

@@ -51,6 +51,10 @@ This package contains the dotnet tooling to electronize your application.</Descr
     <EmbeddedResource Include="..\ElectronNET.Host\main.js" Link="ElectronHost\main.js" />
   </ItemGroup>
 
+  <ItemGroup>
+    <EmbeddedResource Include="..\ElectronNET.Host\build-helper.js" Link="ElectronHost\build-helper.js" />
+  </ItemGroup>
+
   <ItemGroup>
     <EmbeddedResource Include="..\ElectronNET.Host\api\ipc.js" Link="ElectronHost\api\ipc.js" />
   </ItemGroup>

ElectronNET.Host/ElectronHostHook/package.json

@@ -15,6 +15,5 @@
   "devDependencies": {
     "@types/socket.io": "^2.1.2",
     "typescript": "^3.4.5"
-  },
-  "dependencies": {}
+  }
 }

ElectronNET.Host/build-helper.js

@@ -0,0 +1,10 @@
+// @ts-ignore
+const manifestFile = require('./bin/electron.manifest');
+const electronBuilderConfig = JSON.stringify({ ...manifestFile.build });
+
+const fs = require('fs');
+fs.writeFile('./bin/electron-builder.json', electronBuilderConfig, (error) => {
+    if(error) {
+        console.log(error.message);
+    }
+});

ElectronNET.Host/electron.manifest.json

@@ -1,3 +1,28 @@
 {
-  "executable": "{{executable}}"
+  "executable": "{{executable}}",
+  "build": {
+    "appId": "com.{{executable}}.app",
+    "productName": "{{executable}}",
+    "copyright": "Copyright © 2019",
+    "buildVersion": "1.0.0",
+    "compression": "maximum",
+    "directories": {
+      "output": "../../../bin/Desktop"
+    },
+    "extraResources": [
+      {
+        "from": "./bin",
+        "to": "bin",
+        "filter": ["**/*"]
+      }
+    ],
+    "files": [
+      {
+        "from": "./ElectronHostHook/node_modules",
+        "to": "ElectronHostHook/node_modules",
+        "filter": ["**/*"]
+      },
+      "**/*"
+    ]
+  }
 }

ElectronNET.Host/main.js

@@ -8,7 +8,8 @@ let appApi, menu, dialogApi, notification, tray, webContents;
 let globalShortcut, shellApi, screen, clipboard;
 let splashScreen, mainWindowId, hostHook;
 
-const manifestJsonFilePath = path.join(__dirname, 'bin', 'electron.manifest.json');
+const currentBinPath = path.join(__dirname.replace('app.asar', ''), 'bin');
+const manifestJsonFilePath = path.join(currentBinPath, 'electron.manifest.json');
 const manifestJsonFile = require(manifestJsonFilePath);
 if (manifestJsonFile.singleInstance) {
     const shouldQuit = app.requestSingleInstanceLock();
@@ -140,8 +141,8 @@ function startAspCoreBackend(electronPort) {
             binaryFile = binaryFile + '.exe';
         }
 
-        const binFilePath = path.join(__dirname, 'bin', binaryFile);
-        var options = { cwd: path.join(__dirname, 'bin') };
+        let binFilePath = path.join(currentBinPath, binaryFile);
+        var options = { cwd: currentBinPath };
         apiProcess = process(binFilePath, parameters, options);
 
         apiProcess.stdout.on('data', (data) => {

ElectronNET.Host/package.json

@@ -12,14 +12,14 @@
     "start": "tsc -p ."
   },
   "dependencies": {
-    "electron": "^5.0.1",
     "portscanner": "^2.2.0",
     "socket.io": "^2.2.0"
   },
   "devDependencies": {
     "@types/node": "^10.14.4",
     "@types/socket.io": "^2.1.2",
     "tslint": "^5.12.0",
-    "typescript": "^3.2.2"
+    "typescript": "^3.2.2",
+    "electron": "^5.0.1"
   }
 }