chore: remove electron-prebuilt-compile support (#3396)

BREAKING CHANGE: plugin-compile has been discontinued and Forge no longer supports `electron-prebuilt` or `electron-prebuilt-compile`.
electron · Nov 2, 2023 · 126867d · 126867d
1 parent 665a911
commit 126867d
Show file tree

Hide file tree

Showing 15 changed files with 7 additions and 258 deletions.
diff --git a/packages/api/core/src/util/electron-executable.ts b/packages/api/core/src/util/electron-executable.ts
@@ -1,43 +1,12 @@
 import path from 'path';
 
 import { getElectronModulePath } from '@electron-forge/core-utils';
-import chalk from 'chalk';
 import logSymbols from 'log-symbols';
 
 type PackageJSON = Record<string, unknown>;
-type Dependencies = Record<string, string>;
-
-export function pluginCompileExists(packageJSON: PackageJSON): boolean {
-  if (!packageJSON.devDependencies) {
-    return false;
-  }
-
-  const pluginCompileName = '@electron-forge/plugin-compile';
-  const findPluginCompile = (packageName: string): boolean => packageName === pluginCompileName;
-
-  if (Object.keys(packageJSON.devDependencies as Dependencies).find(findPluginCompile)) {
-    return true;
-  }
-
-  if (Object.keys((packageJSON.dependencies as Dependencies) || {}).find(findPluginCompile)) {
-    console.warn(logSymbols.warning, chalk.yellow(`${pluginCompileName} was detected in dependencies, it should be in devDependencies`));
-    return true;
-  }
-
-  return false;
-}
 
 export default async function locateElectronExecutable(dir: string, packageJSON: PackageJSON): Promise<string> {
-  let electronModulePath: string | undefined = await getElectronModulePath(dir, packageJSON);
-  if (electronModulePath?.endsWith('electron-prebuilt-compile') && !pluginCompileExists(packageJSON)) {
-    console.warn(
-      logSymbols.warning,
-      chalk.yellow(
-        'WARNING: found electron-prebuilt-compile without the Electron Forge compile plugin. Please remove the deprecated electron-prebuilt-compile from your devDependencies.'
-      )
-    );
-    electronModulePath = undefined;
-  }
+  const electronModulePath: string | undefined = await getElectronModulePath(dir, packageJSON);
 
   // eslint-disable-next-line @typescript-eslint/no-var-requires
   let electronExecPath = require(electronModulePath || path.resolve(dir, 'node_modules/electron'));

diff --git a/packages/api/core/src/util/upgrade-forge-config.ts b/packages/api/core/src/util/upgrade-forge-config.ts
@@ -168,9 +168,5 @@ export function updateUpgradedForgeDevDeps(packageJSON: ForgePackageJSON, devDep
     (forgeConfig.publishers as IForgeResolvablePublisher[]).map((publisher: IForgeResolvablePublisher) => siblingDep(path.basename(publisher.name)))
   );
 
-  if (Object.keys(packageJSON.devDependencies).find((dep: string) => dep === 'electron-prebuilt-compile')) {
-    devDeps = devDeps.concat(siblingDep('plugin-compile'));
-  }
-
   return devDeps;
 }
diff --git a/packages/api/core/test/fast/electron-executable_spec.ts b/packages/api/core/test/fast/electron-executable_spec.ts
@@ -4,7 +4,7 @@ import chai, { expect } from 'chai';
 import { createSandbox } from 'sinon';
 import sinonChai from 'sinon-chai';
 
-import locateElectronExecutable, { pluginCompileExists } from '../../src/util/electron-executable';
+import locateElectronExecutable from '../../src/util/electron-executable';
 
 chai.use(sinonChai);
 
@@ -30,79 +30,4 @@ describe('locateElectronExecutable', () => {
     await expect(locateElectronExecutable(appFixture, packageJSON)).to.eventually.equal('execPath');
     expect(console.warn).to.not.have.been.called;
   });
-
-  it('warns and returns a hardcoded path to electron if another electron module does not export a string', async () => {
-    const appFixture = path.join(fixtureDir, 'bad-export');
-    const packageJSON = {
-      devDependencies: {
-        '@electron-forge/plugin-compile': '^6.0.0-beta.1',
-        'electron-prebuilt-compile': '^1.4.0',
-      },
-    };
-
-    await expect(locateElectronExecutable(appFixture, packageJSON)).to.eventually.equal('execPath');
-    expect(console.warn).to.have.been.calledOnce;
-  });
-
-  it('warns if prebuilt-compile exists without the corresponding plugin', async () => {
-    const packageJSON = {
-      devDependencies: { 'electron-prebuilt-compile': '1.0.0' },
-    };
-    const compileFixture = path.join(fixtureDir, 'prebuilt-compile');
-
-    await expect(locateElectronExecutable(compileFixture, packageJSON)).to.eventually.be.rejected;
-    expect(console.warn).to.have.been.calledOnce;
-  });
-
-  it('does not warn if prebuilt-compile exists with the corresponding plugin', async () => {
-    const packageJSON = {
-      devDependencies: {
-        '@electron-forge/plugin-compile': '^6.0.0-beta.1',
-        'electron-prebuilt-compile': '1.0.0',
-      },
-    };
-
-    const compileFixture = path.join(fixtureDir, 'prebuilt-compile');
-    await expect(locateElectronExecutable(compileFixture, packageJSON)).to.eventually.be.rejected;
-    expect(console.warn).to.not.have.been.called;
-  });
-});
-
-describe('pluginCompileExists', () => {
-  const sandbox = createSandbox();
-
-  beforeEach(() => {
-    sandbox.spy(console, 'warn');
-  });
-
-  afterEach(() => {
-    sandbox.restore();
-  });
-
-  it('returns false if there is no devDependencies', () => {
-    expect(pluginCompileExists({})).to.equal(false);
-  });
-
-  it('returns false if the plugin is not found in devDependencies', () => {
-    expect(pluginCompileExists({ devDependencies: {} })).to.equal(false);
-  });
-
-  it('returns true if the plugin is found in devDependencies', () => {
-    const packageJSON = {
-      devDependencies: { '@electron-forge/plugin-compile': '^6.0.0-beta.1' },
-    };
-
-    expect(pluginCompileExists(packageJSON)).to.equal(true);
-    expect(console.warn).to.not.have.been.called;
-  });
-
-  it('warns and returns true if the plugin is found in dependencies', () => {
-    const packageJSON = {
-      dependencies: { '@electron-forge/plugin-compile': '^6.0.0-beta.1' },
-      devDependencies: {},
-    };
-
-    expect(pluginCompileExists(packageJSON)).to.equal(true);
-    expect(console.warn).to.have.been.calledOnce;
-  });
 });
diff --git a/packages/api/core/test/fast/upgrade-forge-config_spec.ts b/packages/api/core/test/fast/upgrade-forge-config_spec.ts
@@ -168,16 +168,4 @@ describe('updateUpgradedForgeDevDeps', () => {
     expect(actual.find((dep) => dep.startsWith('@electron-forge/publisher-github'))).to.not.equal(undefined);
     expect(actual.find((dep) => dep.startsWith('@electron-forge/publisher-snapcraft'))).to.not.equal(undefined);
   });
-
-  it('adds electron-compile plugin to devDependencies when electron-prebuilt-compile is in devDependencies', () => {
-    const packageJSON = merge({}, skeletonPackageJSON, {
-      devDependencies: {
-        'electron-prebuilt-compile': '2.0.0',
-      },
-    });
-
-    const actual = updateUpgradedForgeDevDeps(packageJSON, []);
-    expect(actual, JSON.stringify(actual)).to.have.lengthOf(1);
-    expect(actual[0]).to.match(/^@electron-forge\/plugin-compile/);
-  });
 });
diff --git a/packages/api/core/test/fixture/dummy_default_js_conf/package.json b/packages/api/core/test/fixture/dummy_default_js_conf/package.json
@@ -11,6 +11,6 @@
   "author": "",
   "license": "MIT",
   "devDependencies": {
-    "electron-prebuilt": "9.9.9"
+    "electron": "99.99.99"
   }
 }
diff --git a/packages/api/core/test/fixture/dummy_default_ts_conf/package.json b/packages/api/core/test/fixture/dummy_default_ts_conf/package.json
@@ -12,6 +12,6 @@
   "license": "MIT",
   "devDependencies": {
     "@electron-forge/shared-types": "*",
-    "electron-prebuilt": "9.9.9"
+    "electron": "99.99.99"
   }
 }
diff --git a/packages/api/core/test/fixture/dummy_js_conf/package.json b/packages/api/core/test/fixture/dummy_js_conf/package.json
@@ -14,6 +14,6 @@
     "forge": "./forge.different.config.js"
   },
   "devDependencies": {
-    "electron-prebuilt": "9.9.9"
+    "electron": "99.99.99"
   }
 }
diff --git a/packages/api/core/test/fixture/dummy_ts_conf/package.json b/packages/api/core/test/fixture/dummy_ts_conf/package.json
@@ -15,6 +15,6 @@
   },
   "devDependencies": {
     "@electron-forge/shared-types": "*",
-    "electron-prebuilt": "9.9.9"
+    "electron": "99.99.99"
   }
 }
diff --git a/packages/plugin/compile/README.md b/packages/plugin/compile/README.md
diff --git a/packages/plugin/compile/package.json b/packages/plugin/compile/package.json
diff --git a/packages/plugin/compile/src/CompilePlugin.ts b/packages/plugin/compile/src/CompilePlugin.ts
diff --git a/packages/plugin/compile/src/Config.ts b/packages/plugin/compile/src/Config.ts
diff --git a/packages/plugin/compile/src/lib/compile-hook.ts b/packages/plugin/compile/src/lib/compile-hook.ts
diff --git a/packages/utils/core-utils/src/electron-version.ts b/packages/utils/core-utils/src/electron-version.ts
@@ -9,7 +9,7 @@ import { safeYarnOrNpm } from './yarn-or-npm';
 
 const d = debug('electron-forge:electron-version');
 
-const electronPackageNames = ['electron-prebuilt-compile', 'electron-prebuilt', 'electron-nightly', 'electron'];
+const electronPackageNames = ['electron-nightly', 'electron'];
 
 type PackageJSONWithDeps = {
   devDependencies?: Record<string, string>;

diff --git a/packages/utils/core-utils/test/electron-version_spec.ts b/packages/utils/core-utils/test/electron-version_spec.ts
@@ -54,20 +54,6 @@ describe('getElectronVersion', () => {
     return expect(getElectronVersion(fixtureDir, { devDependencies: { electron: '^4.0.2' } })).to.eventually.equal('4.0.9');
   });
 
-  it('works with electron-prebuilt-compile', () => {
-    const packageJSON = {
-      devDependencies: { 'electron-prebuilt-compile': '1.0.0' },
-    };
-    return expect(getElectronVersion('', packageJSON)).to.eventually.equal('1.0.0');
-  });
-
-  it('works with electron-prebuilt', async () => {
-    const packageJSON = {
-      devDependencies: { 'electron-prebuilt': '1.0.0' },
-    };
-    return expect(await getElectronVersion('', packageJSON)).to.be.equal('1.0.0');
-  });
-
   it('works with electron-nightly', async () => {
     const packageJSON = {
       devDependencies: { 'electron-nightly': '5.0.0-nightly.20190107' },