feat: allow disabling maker in config

electron · Mar 3, 2022 · ef05dda · ef05dda
1 parent 204ec25
commit ef05dda
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 1 deletion.
diff --git a/packages/api/core/src/api/make.ts b/packages/api/core/src/api/make.ts
@@ -115,10 +115,10 @@ export default async ({
     if ((target as MakerBase<any>).__isElectronForgeMaker) {
       maker = target as MakerBase<any>;
       /* eslint-enable @typescript-eslint/no-explicit-any */
-      // eslint-disable-next-line no-continue
       if (!maker.platforms.includes(actualTargetPlatform)) continue;
     } else {
       const resolvableTarget: IForgeResolvableMaker = target as IForgeResolvableMaker;
+      if (resolvableTarget.disabled) continue;
 
       if (!resolvableTarget.name) {
         throw new Error(`The following maker config is missing a maker name: ${JSON.stringify(resolvableTarget)}`);

diff --git a/packages/api/core/test/fast/make_spec.ts b/packages/api/core/test/fast/make_spec.ts
@@ -60,4 +60,20 @@ describe('make', () => {
       ).to.eventually.be.rejectedWith(/^The following maker config has a maker name that is not a string:/);
     });
   });
+
+  it('can skip makers via config', async () => {
+    const stubbedMake = proxyquire.noCallThru().load('../../src/api/make', {
+      '../util/read-package-json': {
+        readMutatedPackageJson: () => Promise.resolve(require('../fixture/app-with-maker-skip/package.json')),
+      },
+    }).default;
+    await expect(
+      stubbedMake({
+        arch: 'x64',
+        platform: 'linux',
+        skipPackage: true,
+      })
+    ).to.eventually.be.rejectedWith(/Could not find any make targets configured for the "linux" platform./);
+    proxyquire.callThru();
+  });
 });
diff --git a/packages/api/core/test/fixture/app-with-maker-skip/out/test-linux-x64/.gitkeep b/packages/api/core/test/fixture/app-with-maker-skip/out/test-linux-x64/.gitkeep
diff --git a/packages/api/core/test/fixture/app-with-maker-skip/package.json b/packages/api/core/test/fixture/app-with-maker-skip/package.json
@@ -0,0 +1,19 @@
+{
+  "name": "test",
+  "config": {
+    "forge": {
+      "makers": [
+        {
+          "name": "@electron-forge/maker-zip",
+          "skip": true,
+          "platforms": [
+            "linux"
+          ]
+        }
+      ]
+    }
+  },
+  "devDependencies": {
+    "electron": "^1000.0.0"
+  }
+}
diff --git a/packages/utils/types/src/index.ts b/packages/utils/types/src/index.ts
@@ -70,6 +70,7 @@ export interface IForgePlugin {
 }
 
 export interface IForgeResolvableMaker {
+  disabled: boolean;
   name: string;
   platforms: ForgePlatform[] | null;
   config: any; // eslint-disable-line @typescript-eslint/no-explicit-any