Merge branch 'main' into main

Author: coredev-uk

.circleci/config.yml

@@ -37,7 +37,7 @@ commands:
       - run:
           name: 'Run fast tests'
           command: |
-            yarn test:fast
+            yarn test:fast --reporter=junit --outputFile="./reports/out/test_output.xml"
 
   run-slow-tests:
     steps:
@@ -114,7 +114,7 @@ jobs:
         type: enum
         enum: ['x64', 'arm64']
     executor: << parameters.executor >>
-    parallelism: 2
+    parallelism: 1 # disabled due to being on CircleCI's free plan
     steps:
       - install
       - when:

.eslintignore

@@ -7,3 +7,4 @@ packages/*/*/index.ts
 packages/**/bad.js
 tmpl
 packages/api/core/helper/dynamic-import.js
+packages/plugin/webpack/spec/fixtures/**/*

.eslintrc.json

@@ -48,7 +48,8 @@
       },
       "rules": {
         "no-throw-literal": "off",
-        "@typescript-eslint/no-throw-literal": "error",
+        "@typescript-eslint/no-explicit-any": "warn",
+        "@typescript-eslint/no-unused-expressions": "warn",
         "@typescript-eslint/no-unused-vars": [
           "error",
           {
@@ -57,7 +58,8 @@
             "ignoreRestSiblings": true,
             "vars": "all"
           }
-        ]
+        ],
+        "@typescript-eslint/only-throw-error": "error"
       }
     },
     {
@@ -93,7 +95,7 @@
     {
       "files": ["packages/api/core/test/**/*.ts", "packages/maker/*/src/Maker*.ts"],
       "rules": {
-        "@typescript-eslint/no-var-requires": "off"
+        "@typescript-eslint/no-require-imports": "off"
       }
     },
     {

.prettierignore

@@ -10,5 +10,5 @@ packages/*/*/README.md
 packages/*/*/tsconfig.json
 packages/*/*/typedoc.json
 packages/api/core/test/fixture/bad_external_forge_config/bad.js
-packages/plugin/webpack/test/**/.webpack
+packages/plugin/webpack/spec/**/.webpack
 .links

package.json

@@ -18,11 +18,11 @@
     "lint:markdown-js": "electron-lint-markdown-standard --root . --ignore-path .markdownlintignore --semi \"**/*.md\"",
     "lint:markdown-links": "electron-lint-markdown-links --root . --ignore-path .markdownlintignore \"**/*.md\"",
     "lint": "npm run lint:js && npm run lint:markdown && npm run lint:markdown-js && npm run lint:markdown-links",
-    "lint:fix": "prettier --write .",
+    "lint:fix": "prettier --write . && eslint --fix .",
     "link:prepare": "lerna exec -- node ../../../tools/silent.js yarn link --silent --no-bin-links --link-folder ../../../.links",
     "link:remove": "lerna exec -- node ../../../tools/silent.js yarn unlink --silent --no-bin-links --link-folder ../../../.links",
     "test": "npm run test:clear && xvfb-maybe cross-env NODE_ENV=test TS_NODE_PROJECT='./tsconfig.test.json' TS_NODE_FILES=1 mocha",
-    "test:fast": "npm run test -- --suite=fast",
+    "test:fast": "xvfb-maybe vitest run",
     "test:slow": "npm run test -- --suite=slow",
     "test:clear": "ts-node tools/test-clear",
     "postinstall": "rimraf node_modules/.bin/*.ps1 && ts-node ./tools/gen-tsconfigs.ts && ts-node ./tools/gen-ts-glue.ts",
@@ -91,7 +91,6 @@
     "@types/debug": "^4.1.5",
     "@types/express": "^4.17.9",
     "@types/express-ws": "^3.0.0",
-    "@types/fetch-mock": "^7.3.1",
     "@types/fs-extra": "^9.0.6",
     "@types/interpret": "^1.1.1",
     "@types/keyv": "^3.1.4",
@@ -102,26 +101,22 @@
     "@types/mocha": "^9.0.0",
     "@types/node": "^18.0.3",
     "@types/node-fetch": "^2.5.5",
-    "@types/proxyquire": "^1.3.28",
     "@types/rechoir": "^0.6.1",
     "@types/semver": "^7.3.4",
-    "@types/sinon": "^10.0.0",
-    "@types/sinon-chai": "^3.2.5",
     "@types/which": "^2.0.0",
-    "@typescript-eslint/eslint-plugin": "^5.0.0",
-    "@typescript-eslint/parser": "^5.0.0",
+    "@typescript-eslint/eslint-plugin": "^8.0.0",
+    "@typescript-eslint/parser": "^8.0.0",
     "chai": "^4.3.3",
     "chai-as-promised": "^7.0.0",
     "cross-env": "^7.0.2",
     "electron-installer-common": "^0.10.2",
-    "eslint": "^8.0.1",
-    "eslint-plugin-import": "^2.26.0",
+    "eslint": "^8.56.0",
+    "eslint-plugin-import": "^2.31.0",
     "eslint-plugin-mocha": "^9.0.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^4.0.0",
     "eslint-plugin-promise": "^6.0.0",
     "eslint-plugin-tsdoc": "^0.2.14",
-    "fetch-mock": "^9.10.7",
     "fork-ts-checker-webpack-plugin": "^7.2.13",
     "generate-changelog": "^1.8.0",
     "husky": "^7.0.1",
@@ -131,15 +126,14 @@
     "minimist": "^1.2.6",
     "mocha": "^9.0.1",
     "mocha-junit-reporter": "^2.2.1",
+    "msw": "^2.7.0",
     "prettier": "^2.4.0",
-    "proxyquire": "^2.1.3",
     "rimraf": "^3.0.1",
-    "sinon": "^13.0.1",
-    "sinon-chai": "^3.6.0",
     "syncpack": "^11.2.1",
     "ts-node": "^10.0.0",
     "typedoc": "0.25.13",
-    "typescript": "^4.6.3",
+    "typescript": "~5.4.5",
+    "vitest": "^2.1.6",
     "xvfb-maybe": "^0.2.1",
     "yaml-hook": "^1.0.0"
   },
@@ -168,7 +162,7 @@
   "prettier": {
     "singleQuote": true
   },
-  "packageManager": "[email protected].19+sha1.4ba7fc5c6e704fce2066ecbfb0b0d8976fe62447",
+  "packageManager": "[email protected].22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e",
   "workspaces": {
     "packages": [
       "packages/api/*",
@@ -179,5 +173,8 @@
       "packages/template/*",
       "packages/utils/*"
     ]
+  },
+  "resolutions": {
+    "@malept/eslint-config/@typescript-eslint/parser": "^8.0.0"
   }
 }

packages/api/cli/package.json

@@ -14,7 +14,8 @@
     "@malept/cross-spawn-promise": "^2.0.0",
     "chai": "^4.3.3",
     "chai-as-promised": "^7.0.0",
-    "mocha": "^9.0.1"
+    "mocha": "^9.0.1",
+    "vitest": "^2.1.6"
   },
   "dependencies": {
     "@electron-forge/core": "7.6.0",

packages/api/cli/test/check-system_spec.ts packages/api/cli/spec/check-system.spec.ts

@@ -1,19 +1,19 @@
-import { expect } from 'chai';
+import { describe, expect, it } from 'vitest';
 
 import { checkValidPackageManagerVersion } from '../src/util/check-system';
 
 describe('check-system', () => {
   describe('validPackageManagerVersion', () => {
     it('should consider whitelisted versions to be valid', () => {
-      expect(() => checkValidPackageManagerVersion('NPM', '3.10.1', '^3.0.0')).to.not.throw();
+      expect(() => checkValidPackageManagerVersion('NPM', '3.10.1', '^3.0.0')).not.toThrow();
     });
 
     it('should consider Yarn nightly versions to be invalid', () => {
-      expect(() => checkValidPackageManagerVersion('Yarn', '0.23.0-20170311.0515', '0.23.0')).to.throw();
+      expect(() => checkValidPackageManagerVersion('Yarn', '0.23.0-20170311.0515', '0.23.0')).toThrow();
     });
 
     it('should consider invalid semver versions to be invalid', () => {
-      expect(() => checkValidPackageManagerVersion('Yarn', '0.22', '0.22.0')).to.throw();
+      expect(() => checkValidPackageManagerVersion('Yarn', '0.22', '0.22.0')).toThrow();
     });
   });
 });

packages/api/cli/spec/cli.spec.ts

@@ -0,0 +1,19 @@
+import path from 'node:path';
+
+import { spawn } from '@malept/cross-spawn-promise';
+import { describe, expect, it } from 'vitest';
+
+function runForgeCLI(...extraArgs: string[]): Promise<string> {
+  const args = ['ts-node', path.resolve(__dirname, '../src/electron-forge.ts'), ...extraArgs];
+  return spawn('npx', args);
+}
+
+describe('cli', { timeout: 30_000 }, () => {
+  it('should not fail on known subcommands', async () => {
+    await expect(runForgeCLI('help')).resolves.toMatch(/Usage:/);
+  });
+
+  it('should fail on unknown subcommands', async () => {
+    await expect(runForgeCLI('nonexistent')).rejects.toThrow(Error);
+  });
+});

packages/api/cli/src/electron-forge-make.ts

@@ -1,7 +1,7 @@
 import path from 'node:path';
 
-import { api, MakeOptions } from '@electron-forge/core';
 import { initializeProxy } from '@electron/get';
+import { api, MakeOptions } from '@electron-forge/core';
 import program from 'commander';
 import fs from 'fs-extra';
 

packages/api/cli/src/electron-forge-package.ts

@@ -1,7 +1,7 @@
 import path from 'node:path';
 
-import { api, PackageOptions } from '@electron-forge/core';
 import { initializeProxy } from '@electron/get';
+import { api, PackageOptions } from '@electron-forge/core';
 import program from 'commander';
 import fs from 'fs-extra';
 

packages/api/cli/src/electron-forge-publish.ts

@@ -1,7 +1,7 @@
 import path from 'node:path';
 
-import { api, PublishOptions } from '@electron-forge/core';
 import { initializeProxy } from '@electron/get';
+import { api, PublishOptions } from '@electron-forge/core';
 import program from 'commander';
 import fs from 'fs-extra';
 

packages/api/cli/src/electron-forge.ts

@@ -9,7 +9,7 @@ import './util/terminate';
 
 import { checkSystem } from './util/check-system';
 
-// eslint-disable-next-line @typescript-eslint/no-var-requires
+// eslint-disable-next-line @typescript-eslint/no-require-imports
 const metadata = require('../package.json');
 
 const originalSC = program.executeSubCommand.bind(program);

packages/api/cli/test/cli_spec.ts

@@ -32,11 +32,8 @@
     "chai-as-promised": "^7.0.0",
     "cross-env": "^7.0.2",
     "electron-installer-common": "^0.10.2",
-    "fetch-mock": "^9.10.7",
     "mocha": "^9.0.1",
-    "proxyquire": "^2.1.3",
-    "sinon": "^13.0.1",
-    "sinon-chai": "^3.6.0",
+    "vitest": "^2.1.6",
     "yaml-hook": "^1.0.0"
   },
   "dependencies": {

packages/api/core/package.json

@@ -0,0 +1,87 @@
+/* eslint-disable node/no-unsupported-features/es-syntax */
+import * as path from 'node:path';
+
+import { describe, expect, it, vi } from 'vitest';
+
+import make from '../../src/api/make';
+
+vi.mock(import('@electron-forge/core-utils'), async (importOriginal) => {
+  const mod = await importOriginal();
+  return {
+    ...mod,
+    getElectronVersion: vi.fn().mockResolvedValue('1.0.0'),
+  };
+});
+
+describe('make', () => {
+  const fixtureDir = path.resolve(__dirname, '../../test/fixture');
+
+  it.todo('should call "package"');
+
+  it('works with @scoped package names', { timeout: 10_000 }, async () => {
+    const result = await make({
+      arch: 'x64',
+      dir: path.join(fixtureDir, 'app-with-scoped-name'),
+      platform: 'linux',
+      skipPackage: true,
+    });
+    expect(result).toHaveLength(1);
+    expect(result[0].artifacts).toEqual([expect.stringContaining('@scope-package-linux-x64-1.0.0.zip')]);
+  });
+
+  it('can override targets', async () => {
+    const results = await make({
+      arch: 'x64',
+      dir: path.join(fixtureDir, 'app-with-custom-maker-config'),
+      overrideTargets: ['../custom-maker'],
+      platform: 'linux',
+      skipPackage: true,
+    });
+
+    expect(results[0].artifacts).toEqual(['from config']);
+  });
+
+  it('throws an error if the name is not a string', async () => {
+    await expect(
+      make({
+        arch: 'x64',
+        dir: path.join(fixtureDir, 'maker-name-wrong-type'),
+        platform: 'linux',
+        skipPackage: true,
+      })
+    ).rejects.toThrowError(/^The following maker config has a maker name that is not a string:/);
+  });
+
+  it('throws an error if the name is missing', async () => {
+    await expect(
+      make({
+        arch: 'x64',
+        dir: path.join(fixtureDir, 'maker-sans-name'),
+        platform: 'linux',
+        skipPackage: true,
+      })
+    ).rejects.toThrowError(/^The following maker config is missing a maker name:/);
+  });
+
+  it('can skip makers via config', async () => {
+    await expect(
+      make({
+        arch: 'x64',
+        dir: path.join(fixtureDir, 'app-with-maker-disable'),
+        platform: 'linux',
+        skipPackage: true,
+      })
+    ).rejects.toThrowError(/Could not find any make targets configured for the "linux" platform./);
+  });
+
+  it('throws if maker cannot be resolved', async () => {
+    const opts = {
+      arch: 'x64',
+      dir: path.join(fixtureDir, 'app-with-custom-maker-config'),
+      platform: 'linux',
+      skipPackage: true,
+    };
+
+    await expect(make(opts)).rejects.toThrowError("Could not find module with name '@electron-forge/non-existent-forge-maker'");
+  });
+});