feat: allow a custom out dir from forge config (#3458)

Co-authored-by: Keeley Hammond <[email protected]>

Author: lutzroeder

packages/api/core/src/util/out-dir.ts

@@ -5,12 +5,15 @@ import { ResolvedForgeConfig } from '@electron-forge/shared-types';
 const BASE_OUT_DIR = 'out';
 
 export default (baseDir: string, forgeConfig: ResolvedForgeConfig): string => {
+  const baseOutDir = forgeConfig.outDir || BASE_OUT_DIR;
+
   if (forgeConfig.buildIdentifier) {
     let identifier = forgeConfig.buildIdentifier;
     if (typeof identifier === 'function') {
       identifier = identifier();
     }
-    if (identifier) return path.resolve(baseDir, BASE_OUT_DIR, identifier);
+    if (identifier) return path.resolve(baseDir, baseOutDir, identifier);
   }
-  return path.resolve(baseDir, BASE_OUT_DIR);
+
+  return path.resolve(baseDir, baseOutDir);
 };

packages/api/core/test/fast/out-dir_spec.ts

@@ -30,3 +30,35 @@ describe('out-dir', () => {
     });
   });
 });
+
+describe('out-dir-dist', () => {
+  const DIR = __dirname;
+
+  describe('getCurrentOutDir', () => {
+    it('resolves to the dist directory when dist is declared', () => {
+      expect(
+        getCurrentOutDir(DIR, {
+          outDir: 'dist',
+        } as ResolvedForgeConfig)
+      ).to.equal(`${DIR}${path.sep}dist`);
+    });
+
+    it('resolves to the provided identifier', () => {
+      expect(
+        getCurrentOutDir(DIR, {
+          buildIdentifier: 'bar',
+          outDir: 'dist',
+        } as ResolvedForgeConfig)
+      ).to.equal(`${DIR}${path.sep}dist${path.sep}bar`);
+    });
+
+    it('resolves to the return value of provided identifier getter', () => {
+      expect(
+        getCurrentOutDir(DIR, {
+          buildIdentifier: () => 'thing',
+          outDir: 'dist',
+        } as ResolvedForgeConfig)
+      ).to.equal(`${DIR}${path.sep}dist${path.sep}thing`);
+    });
+  });
+});

packages/utils/types/src/index.ts

@@ -85,6 +85,10 @@ export interface ResolvedForgeConfig {
    * If a function is provided, it must synchronously return the buildIdentifier
    */
   buildIdentifier?: string | (() => string);
+  /**
+   * Output directory. Default is './out'.
+   */
+  outDir?: string;
   hooks?: ForgeHookMap;
   /**
    * @internal