feat(core): resolve forge.config.js by default if it exists (#569)

electron · Sep 10, 2018 · 5431dfa · 5431dfa
1 parent f37476b
commit 5431dfa
Show file tree

Hide file tree

Showing 8 changed files with 38 additions and 4 deletions.
diff --git a/packages/api/core/src/api/package.ts b/packages/api/core/src/api/package.ts
@@ -82,7 +82,7 @@ export default async ({
  dir = process.cwd(),
  interactive = false,
  arch = hostArch(),
- platform = process.platform,
+ platform = process.platform as ForgePlatform,
  outDir,
 }: PackageOptions) => {
  const ora = interactive ? realOra : fakeOra;

diff --git a/packages/api/core/src/util/forge-config.ts b/packages/api/core/src/util/forge-config.ts
@@ -72,7 +72,15 @@ export function fromBuildIdentifier<T>(map: { [key: string]: T | undefined }) {
 
 export default async (dir: string) => {
  const packageJSON = await readRawPackageJson(dir);
- let forgeConfig: ForgeConfig | string = (packageJSON.config && packageJSON.config.forge) ? packageJSON.config.forge : {};
+ let forgeConfig: ForgeConfig | string | null = (packageJSON.config && packageJSON.config.forge) ? packageJSON.config.forge : null;
+
+ if (!forgeConfig) {
+ if (await fs.pathExists(path.resolve(dir, 'forge.config.js'))) {
+ forgeConfig = 'forge.config.js';
+ } else {
+ forgeConfig = {} as any as ForgeConfig;
+ }
+ }
 
  if (typeof forgeConfig === 'string' && (await fs.pathExists(path.resolve(dir, forgeConfig)) || await fs.pathExists(path.resolve(dir, `${forgeConfig}.js`)))) {
  try {

diff --git a/packages/api/core/test/fast/forge-config_spec.ts b/packages/api/core/test/fast/forge-config_spec.ts
@@ -71,6 +71,12 @@ describe('forge-config', () => {
  expect(conf.magicFn()).to.be.equal('magic result');
  });
 
+ it('should resolve the JS file exports of forge.config.js if config.forge does not exist points', async () => {
+ const conf: any = await findConfig(path.resolve(__dirname, '../fixture/dummy_default_js_conf'));
+ expect(conf.buildIdentifier).to.equal('default');
+ expect(conf.defaultResolved).to.equal(true);
+ });
+
  it('should magically map properties to environment variables', async () => {
  const conf: any = await findConfig(path.resolve(__dirname, '../fixture/dummy_js_conf'));
  expect(conf.s3.secretAccessKey).to.equal(undefined);

diff --git a/packages/api/core/test/fixture/dummy_default_js_conf/forge.config.js b/packages/api/core/test/fixture/dummy_default_js_conf/forge.config.js
@@ -0,0 +1,4 @@
+module.exports = {
+ buildIdentifier: 'default',
+ defaultResolved: true,
+};
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
@@ -0,0 +1,16 @@
+{
+ "name": "",
+ "productName": "",
+ "version": "1.0.0",
+ "description": "",
+ "main": "src/index.js",
+ "scripts": {
+ "start": "electron-forge start"
+ },
+ "keywords": [],
+ "author": "",
+ "license": "MIT",
+ "devDependencies": {
+ "electron-prebuilt": "9.9.9"
+ }
+}
diff --git a/...est/fixture/dummy_js_conf/forge.config.js → ...e/dummy_js_conf/forge.different.config.js b/...est/fixture/dummy_js_conf/forge.config.js → ...e/dummy_js_conf/forge.different.config.js
diff --git a/packages/api/core/test/fixture/dummy_js_conf/package.json b/packages/api/core/test/fixture/dummy_js_conf/package.json
@@ -11,7 +11,7 @@
  "author": "",
  "license": "MIT",
  "config": {
- "forge": "./forge.config.js"
+ "forge": "./forge.different.config.js"
  },
  "devDependencies": {
  "electron-prebuilt": "9.9.9"

diff --git a/packages/utils/types/src/index.ts b/packages/utils/types/src/index.ts
@@ -6,7 +6,7 @@ import { RebuildOptions } from 'electron-rebuild/lib/src/rebuild';
 
 // declare module '@electron-forge/shared-types' {
  export type ForgePlatform = 'darwin' | 'mas' | 'win32' | 'linux';
- export type ForgeArch = 'ia32' | 'x64' | 'armv7l' | 'arm';
+ export type ForgeArch = 'ia32' | 'x64' | 'armv7l' | 'arm' | 'all';
  export type ForgeHookFn = (forgeConfig: ForgeConfig, ...args: any[]) => Promise<any>;
  export interface IForgePluginInterface {
  triggerHook(hookName: string, hookArgs: any[]): Promise<void>;