fix(core): allow the forge.config property in package.json to point to a non-js file (#3070)

erikian · web-flow · commit 2e5a8bc2912f · 2022-11-15T17:13:08.000-08:00
diff --git a/package.json b/package.json
@@ -138,7 +138,8 @@
     "typedoc-plugin-missing-exports": "^1.0.0",
     "typedoc-plugin-rename-defaults": "^0.6.4",
     "typescript": "^4.6.3",
-    "xvfb-maybe": "^0.2.1"
+    "xvfb-maybe": "^0.2.1",
+    "yaml-hook": "^1.0.0"
   },
   "optionalDependencies": {
     "@malept/electron-installer-flatpak": "^0.11.2",
diff --git a/packages/api/core/package.json b/packages/api/core/package.json
@@ -36,7 +36,8 @@
     "mocha": "^9.0.1",
     "proxyquire": "^2.1.3",
     "sinon": "^13.0.1",
-    "sinon-chai": "^3.6.0"
+    "sinon-chai": "^3.6.0",
+    "yaml-hook": "^1.0.0"
   },
   "dependencies": {
     "@electron-forge/core-utils": "^6.0.3",
diff --git a/packages/api/core/src/util/forge-config.ts b/packages/api/core/src/util/forge-config.ts
@@ -109,7 +109,7 @@ export default async (dir: string): Promise<ResolvedForgeConfig> => {
   const packageJSON = await readRawPackageJson(dir);
   let forgeConfig: ForgeConfig | string | null = packageJSON.config && packageJSON.config.forge ? packageJSON.config.forge : null;
 
-  if (!forgeConfig) {
+  if (!forgeConfig || typeof forgeConfig === 'string') {
     for (const extension of ['.js', ...Object.keys(interpret.extensions)]) {
       const pathToConfig = path.resolve(dir, `forge.config${extension}`);
       if (await fs.pathExists(pathToConfig)) {
diff --git a/packages/api/core/test/fast/forge-config_spec.ts b/packages/api/core/test/fast/forge-config_spec.ts
@@ -114,6 +114,12 @@ describe('forge-config', () => {
     expect(conf.defaultResolved).to.equal(true);
   });
 
+  it(`should resolve the yml config from forge.config.yml if it's specified in config.forge`, async () => {
+    type DefaultResolvedConfig = ResolvedForgeConfig;
+    const conf = (await findConfig(path.resolve(__dirname, '../fixture/dummy_ts_conf'))) as DefaultResolvedConfig;
+    expect(conf.buildIdentifier).to.equal('yml');
+  });
+
   it('should resolve the TS file exports of forge.config.ts if config.forge does not exist and the TS config exists', async () => {
     type DefaultResolvedConfig = ResolvedForgeConfig;
     const conf = (await findConfig(path.resolve(__dirname, '../fixture/dummy_default_ts_conf'))) as DefaultResolvedConfig;
diff --git a/packages/api/core/test/fixture/dummy_ts_conf/forge.config.yml b/packages/api/core/test/fixture/dummy_ts_conf/forge.config.yml
@@ -0,0 +1 @@
+buildIdentifier: 'yml'
diff --git a/packages/api/core/test/fixture/dummy_ts_conf/package.json b/packages/api/core/test/fixture/dummy_ts_conf/package.json
@@ -0,0 +1,20 @@
+{
+  "name": "",
+  "productName": "",
+  "version": "1.0.0",
+  "description": "",
+  "main": "src/index.js",
+  "scripts": {
+    "start": "electron-forge start"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "MIT",
+  "config": {
+    "forge": "./forge.config.yml"
+  },
+  "devDependencies": {
+    "@electron-forge/shared-types": "*",
+    "electron-prebuilt": "9.9.9"
+  }
+}
diff --git a/yarn.lock b/yarn.lock
@@ -7493,7 +7493,7 @@ js-yaml@4.1.0, js-yaml@^4.1.0:
   dependencies:
     argparse "^2.0.1"
 
-js-yaml@^3.10.0, js-yaml@^3.13.1:
+js-yaml@^3.10.0, js-yaml@^3.12.2, js-yaml@^3.13.1:
   version "3.14.1"
   resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-3.14.1.tgz#dae812fdb3825fa306609a8717383c50c36a0537"
   integrity sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g==
@@ -11555,6 +11555,14 @@ yallist@^4.0.0:
   resolved "https://registry.yarnpkg.com/yallist/-/yallist-4.0.0.tgz#9bb92790d9c0effec63be73519e11a35019a3a72"
   integrity sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==
 
+yaml-hook@^1.0.0:
+  version "1.0.0"
+  resolved "https://registry.yarnpkg.com/yaml-hook/-/yaml-hook-1.0.0.tgz#14d682e949a9cf6f041e2af8278a4d349ccb52b7"
+  integrity sha512-iqSS5Mk1F3yBtrfx94hWzmEk0Wxs5QoBRvngAe39t0XA2JJ3jhQN6Snwv/shH1VoZr+ntdhf4EDLmW0WUWBjdQ==
+  dependencies:
+    js-yaml "^3.12.2"
+    pirates "^4.0.1"
+
 yaml@^1.10.0, yaml@^1.10.2:
   version "1.10.2"
   resolved "https://registry.yarnpkg.com/yaml/-/yaml-1.10.2.tgz#2301c5ffbf12b467de8da2333a459e29e7920e4b"
