feat: support custom Electron version (#230)

* feat: support custom Electron version
* chore: remove require.resolve

Author: erisu

lib/build.js

@@ -20,7 +20,7 @@
 const fs = require('fs-extra');
 const path = require('path');
 const events = require('cordova-common').events;
-const { deepMerge } = require('./util');
+const { deepMerge, getInstalledElectronVersion } = require('./util');
 
 const PLATFORM_MAPPING = {
     linux: 'linux',
@@ -321,14 +321,16 @@ class ElectronBuilder {
     injectProjectConfigToBuildSettings () {
         // const isDevelopment = false;
         const packageJson = require(path.join(this.api.locations.www, 'package.json'));
+
         const userConfig = {
             APP_ID: packageJson.name,
             APP_TITLE: packageJson.displayName,
             APP_INSTALLER_ICON: 'installer.png',
             APP_BUILD_DIR: this.api.locations.build,
             APP_BUILD_RES_DIR: this.api.locations.buildRes,
             APP_WWW_DIR: this.api.locations.www,
-            BUILD_TYPE: this.isDevelopment ? 'development' : 'distribution'
+            BUILD_TYPE: this.isDevelopment ? 'development' : 'distribution',
+            ELECTRON_INSTALLED_VERSION: getInstalledElectronVersion()
         };
 
         // convert to string for string replacement

lib/build/base.json

@@ -8,10 +8,10 @@
       "buildResources": "${APP_BUILD_RES_DIR}",
       "output": "${APP_BUILD_DIR}"
     },
-    "electronVersion": "14.2.9",
+    "electronVersion": "${ELECTRON_INSTALLED_VERSION}",
 
     "electronDownload": {
-      "version": "14.2.9"
+      "version": "${ELECTRON_INSTALLED_VERSION}"
     }
   }
 }

lib/util.js

@@ -56,3 +56,12 @@ module.exports.getPackageJson = () => {
 
     return _packageJson;
 };
+
+/**
+ * Gets the installed Electron version from the Electron dependency package.json file.
+ *
+ * @return {String} version of installed Electron dependency
+ */
+module.exports.getInstalledElectronVersion = () => {
+    return require('electron/package.json').version;
+};

tests/spec/unit/lib/build.spec.js

@@ -140,15 +140,17 @@ describe('Testing build.js:', () => {
             const buildOptions = { debug: true, buildConfig, argv: [] };
 
             // create spies
+            const getInstalledElectronVersionSpy = jasmine.createSpy('getInstalledElectronVersion').and.returnValue('1.33.7');
             existsSyncSpy = jasmine.createSpy('existsSync').and.returnValue(true);
             requireSpy = jasmine.createSpy('require').and.returnValue(buildConfig);
             build.__set__('fs', { existsSync: existsSyncSpy });
-            build.__set__({ require: requireSpy });
+            build.__set__({ require: requireSpy, getInstalledElectronVersion: getInstalledElectronVersionSpy });
 
             electronBuilder = new ElectronBuilder(buildOptions, api).configure();
 
             expect(existsSyncSpy).toHaveBeenCalled();
             expect(requireSpy).toHaveBeenCalled();
+            expect(getInstalledElectronVersionSpy).toHaveBeenCalled();
             expect(electronBuilder.buildSettings).toEqual(buildConfig);
         });
 
@@ -167,15 +169,17 @@ describe('Testing build.js:', () => {
             const buildOptions = { debug: false, buildConfig, argv: [] };
 
             // create spies
+            const getInstalledElectronVersionSpy = jasmine.createSpy('getInstalledElectronVersion').and.returnValue('1.33.7');
             existsSyncSpy = jasmine.createSpy('existsSync').and.returnValue(true);
             requireSpy = jasmine.createSpy('require').and.returnValue(buildConfig);
             build.__set__('fs', { existsSync: existsSyncSpy });
-            build.__set__({ require: requireSpy });
+            build.__set__({ require: requireSpy, getInstalledElectronVersion: getInstalledElectronVersionSpy });
 
             electronBuilder = new ElectronBuilder(buildOptions, api).configure();
 
             expect(existsSyncSpy).toHaveBeenCalled();
             expect(requireSpy).toHaveBeenCalled();
+            expect(getInstalledElectronVersionSpy).toHaveBeenCalled();
             expect(electronBuilder.buildSettings).toEqual(buildConfig);
         });
 

tests/spec/unit/lib/util.spec.js

@@ -55,4 +55,13 @@ describe('Testing util.js:', () => {
             expect({}.hoge).toBe(undefined);
         });
     });
+
+    describe('getInstalledElectronVersion method', () => {
+        it('should have a version', () => {
+            const actual = util.getInstalledElectronVersion();
+
+            expect(actual).not.toBe(null);
+            expect(actual).not.toBe(undefined);
+        });
+    });
 });