@electron-forge/test-utils 8.0.0-alpha.3 → 8.0.0-alpha.5

package/dist/index.d.ts

@@ -1,13 +1,22 @@
+export type PackageJSON = Record<string, unknown> & {
+    config?: {
+        forge?: Record<string, unknown>;
+    };
+    dependencies?: Record<string, string>;
+    devDependencies?: Record<string, string>;
+};
 export declare function runNPMInstall(dir: string, ...args: string[]): Promise<void>;
 export declare function ensureModulesInstalled(dir: string, deps: string[], devDeps: string[]): Promise<void>;
 export declare function ensureTestDirIsNonexistent(): Promise<string>;
 export declare function expectLintToPass(dir: string): Promise<void>;
 /**
- * Helper function to mock CommonJS `require` calls with Vitest.
+ * Mutates the `package.json` file in a directory.
+ * Use the return value to later restore the original `package.json` value
+ * in a subsequent call of this function.
  *
- * @see https://github.com/vitest-dev/vitest/discussions/3134
- * @param mockedUri - mocked module URI
- * @param stub - stub function to assign to mock
+ * @param dir - The target directory containing the `package.json` file
+ * @param callback - A callback function that returns the value of the new `package.json` to be applied
+ * @returns The original `package.json` prior to mutation
  */
-export declare function mockRequire(mockedUri: string, stub: any): Promise<void>;
+export declare function updatePackageJSON(dir: string, callback: (packageJSON: PackageJSON) => Promise<PackageJSON>): Promise<any>;
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAUA,wBAAsB,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,iBAEjE;AAED,wBAAsB,sBAAsB,CAC1C,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EAAE,EACd,OAAO,EAAE,MAAM,EAAE,GAChB,OAAO,CAAC,IAAI,CAAC,CAGf;AAID,wBAAsB,0BAA0B,IAAI,OAAO,CAAC,MAAM,CAAC,CAMlE;AAED,wBAAsB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAUjE;AAED;;;;;;GAMG;AAEH,wBAAsB,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,iBAW7D"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAMA,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IAClD,MAAM,CAAC,EAAE;QACP,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACjC,CAAC;IACF,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC1C,CAAC;AAMF,wBAAsB,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,iBAEjE;AAED,wBAAsB,sBAAsB,CAC1C,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EAAE,EACd,OAAO,EAAE,MAAM,EAAE,GAChB,OAAO,CAAC,IAAI,CAAC,CAGf;AAID,wBAAsB,0BAA0B,IAAI,OAAO,CAAC,MAAM,CAAC,CAMlE;AAED,wBAAsB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAUjE;AAED;;;;;;;;GAQG;AACH,wBAAsB,iBAAiB,CACrC,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,CAAC,WAAW,EAAE,WAAW,KAAK,OAAO,CAAC,WAAW,CAAC,gBAU7D"}

package/dist/index.js

@@ -1,88 +1,49 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.mockRequire = exports.expectLintToPass = exports.ensureTestDirIsNonexistent = exports.ensureModulesInstalled = exports.runNPMInstall = void 0;
-const node_fs_1 = __importDefault(require("node:fs"));
-const node_os_1 = __importDefault(require("node:os"));
-const node_path_1 = __importDefault(require("node:path"));
-const cross_spawn_promise_1 = require("@malept/cross-spawn-promise");
+import os from 'node:os';
+import path from 'node:path';
+import { ExitError, spawn } from '@malept/cross-spawn-promise';
+import fs from 'fs-extra';
 async function runNPM(dir, ...args) {
-    await (0, cross_spawn_promise_1.spawn)('npm', args, { cwd: dir });
+    await spawn('npm', args, { cwd: dir });
 }
-async function runNPMInstall(dir, ...args) {
+export async function runNPMInstall(dir, ...args) {
     await runNPM(dir, 'install', ...args);
 }
-exports.runNPMInstall = runNPMInstall;
-async function ensureModulesInstalled(dir, deps, devDeps) {
+export async function ensureModulesInstalled(dir, deps, devDeps) {
     await runNPMInstall(dir, ...deps);
     await runNPMInstall(dir, '--save-dev', ...devDeps);
 }
-exports.ensureModulesInstalled = ensureModulesInstalled;
 let dirID = Date.now();
-async function ensureTestDirIsNonexistent() {
-    const dir = node_path_1.default.resolve(node_os_1.default.tmpdir(), `electron-forge-test-${dirID}`);
+export async function ensureTestDirIsNonexistent() {
+    const dir = path.resolve(os.tmpdir(), `electron-forge-test-${dirID}`);
     dirID += 1;
-    await node_fs_1.default.promises.rm(dir, { recursive: true, force: true });
+    await fs.promises.rm(dir, { recursive: true, force: true });
     return dir;
 }
-exports.ensureTestDirIsNonexistent = ensureTestDirIsNonexistent;
-async function expectLintToPass(dir) {
+export async function expectLintToPass(dir) {
     try {
         await runNPM(dir, 'run', 'lint');
     }
     catch (err) {
-        if (err instanceof cross_spawn_promise_1.ExitError) {
+        if (err instanceof ExitError) {
             console.error('STDOUT:', err.stdout.toString());
             console.error('STDERR:', err.stderr.toString());
         }
         throw err;
     }
 }
-exports.expectLintToPass = expectLintToPass;
 /**
- * Helper function to mock CommonJS `require` calls with Vitest.
+ * Mutates the `package.json` file in a directory.
+ * Use the return value to later restore the original `package.json` value
+ * in a subsequent call of this function.
  *
- * @see https://github.com/vitest-dev/vitest/discussions/3134
- * @param mockedUri - mocked module URI
- * @param stub - stub function to assign to mock
+ * @param dir - The target directory containing the `package.json` file
+ * @param callback - A callback function that returns the value of the new `package.json` to be applied
+ * @returns The original `package.json` prior to mutation
  */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-async function mockRequire(mockedUri, stub) {
-    const { Module } = await Promise.resolve().then(() => __importStar(require('module')));
-    //@ts-expect-error undocumented functions
-    Module._load_original = Module._load;
-    //@ts-expect-error undocumented functions
-    Module._load = (uri, parent) => {
-        if (uri === mockedUri)
-            return stub;
-        //@ts-expect-error undocumented functions
-        return Module._load_original(uri, parent);
-    };
+export async function updatePackageJSON(dir, callback) {
+    const packageJSON = await fs.readJson(path.resolve(dir, 'package.json'));
+    const mutated = await callback(JSON.parse(JSON.stringify(packageJSON)));
+    await fs.promises.writeFile(path.resolve(dir, 'package.json'), JSON.stringify(mutated, null, 2), 'utf-8');
+    return packageJSON;
 }
-exports.mockRequire = mockRequire;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQSxzREFBeUI7QUFDekIsc0RBQXlCO0FBQ3pCLDBEQUE2QjtBQUU3QixxRUFBK0Q7QUFFL0QsS0FBSyxVQUFVLE1BQU0sQ0FBQyxHQUFXLEVBQUUsR0FBRyxJQUFjO0lBQ2xELE1BQU0sSUFBQSwyQkFBSyxFQUFDLEtBQUssRUFBRSxJQUFJLEVBQUUsRUFBRSxHQUFHLEVBQUUsR0FBRyxFQUFFLENBQUMsQ0FBQztBQUN6QyxDQUFDO0FBRU0sS0FBSyxVQUFVLGFBQWEsQ0FBQyxHQUFXLEVBQUUsR0FBRyxJQUFjO0lBQ2hFLE1BQU0sTUFBTSxDQUFDLEdBQUcsRUFBRSxTQUFTLEVBQUUsR0FBRyxJQUFJLENBQUMsQ0FBQztBQUN4QyxDQUFDO0FBRkQsc0NBRUM7QUFFTSxLQUFLLFVBQVUsc0JBQXNCLENBQzFDLEdBQVcsRUFDWCxJQUFjLEVBQ2QsT0FBaUI7SUFFakIsTUFBTSxhQUFhLENBQUMsR0FBRyxFQUFFLEdBQUcsSUFBSSxDQUFDLENBQUM7SUFDbEMsTUFBTSxhQUFhLENBQUMsR0FBRyxFQUFFLFlBQVksRUFBRSxHQUFHLE9BQU8sQ0FBQyxDQUFDO0FBQ3JELENBQUM7QUFQRCx3REFPQztBQUVELElBQUksS0FBSyxHQUFHLElBQUksQ0FBQyxHQUFHLEVBQUUsQ0FBQztBQUVoQixLQUFLLFVBQVUsMEJBQTBCO0lBQzlDLE1BQU0sR0FBRyxHQUFHLG1CQUFJLENBQUMsT0FBTyxDQUFDLGlCQUFFLENBQUMsTUFBTSxFQUFFLEVBQUUsdUJBQXVCLEtBQUssRUFBRSxDQUFDLENBQUM7SUFDdEUsS0FBSyxJQUFJLENBQUMsQ0FBQztJQUNYLE1BQU0saUJBQUUsQ0FBQyxRQUFRLENBQUMsRUFBRSxDQUFDLEdBQUcsRUFBRSxFQUFFLFNBQVMsRUFBRSxJQUFJLEVBQUUsS0FBSyxFQUFFLElBQUksRUFBRSxDQUFDLENBQUM7SUFFNUQsT0FBTyxHQUFHLENBQUM7QUFDYixDQUFDO0FBTkQsZ0VBTUM7QUFFTSxLQUFLLFVBQVUsZ0JBQWdCLENBQUMsR0FBVztJQUNoRCxJQUFJLENBQUM7UUFDSCxNQUFNLE1BQU0sQ0FBQyxHQUFHLEVBQUUsS0FBSyxFQUFFLE1BQU0sQ0FBQyxDQUFDO0lBQ25DLENBQUM7SUFBQyxPQUFPLEdBQUcsRUFBRSxDQUFDO1FBQ2IsSUFBSSxHQUFHLFlBQVksK0JBQVMsRUFBRSxDQUFDO1lBQzdCLE9BQU8sQ0FBQyxLQUFLLENBQUMsU0FBUyxFQUFFLEdBQUcsQ0FBQyxNQUFNLENBQUMsUUFBUSxFQUFFLENBQUMsQ0FBQztZQUNoRCxPQUFPLENBQUMsS0FBSyxDQUFDLFNBQVMsRUFBRSxHQUFHLENBQUMsTUFBTSxDQUFDLFFBQVEsRUFBRSxDQUFDLENBQUM7UUFDbEQsQ0FBQztRQUNELE1BQU0sR0FBRyxDQUFDO0lBQ1osQ0FBQztBQUNILENBQUM7QUFWRCw0Q0FVQztBQUVEOzs7Ozs7R0FNRztBQUNILDhEQUE4RDtBQUN2RCxLQUFLLFVBQVUsV0FBVyxDQUFDLFNBQWlCLEVBQUUsSUFBUztJQUM1RCxNQUFNLEVBQUUsTUFBTSxFQUFFLEdBQUcsd0RBQWEsUUFBUSxHQUFDLENBQUM7SUFFMUMseUNBQXlDO0lBQ3pDLE1BQU0sQ0FBQyxjQUFjLEdBQUcsTUFBTSxDQUFDLEtBQUssQ0FBQztJQUNyQyx5Q0FBeUM7SUFDekMsTUFBTSxDQUFDLEtBQUssR0FBRyxDQUFDLEdBQUcsRUFBRSxNQUFNLEVBQUUsRUFBRTtRQUM3QixJQUFJLEdBQUcsS0FBSyxTQUFTO1lBQUUsT0FBTyxJQUFJLENBQUM7UUFDbkMseUNBQXlDO1FBQ3pDLE9BQU8sTUFBTSxDQUFDLGNBQWMsQ0FBQyxHQUFHLEVBQUUsTUFBTSxDQUFDLENBQUM7SUFDNUMsQ0FBQyxDQUFDO0FBQ0osQ0FBQztBQVhELGtDQVdDIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLE1BQU0sU0FBUyxDQUFDO0FBQ3pCLE9BQU8sSUFBSSxNQUFNLFdBQVcsQ0FBQztBQUU3QixPQUFPLEVBQUUsU0FBUyxFQUFFLEtBQUssRUFBRSxNQUFNLDZCQUE2QixDQUFDO0FBQy9ELE9BQU8sRUFBRSxNQUFNLFVBQVUsQ0FBQztBQVUxQixLQUFLLFVBQVUsTUFBTSxDQUFDLEdBQVcsRUFBRSxHQUFHLElBQWM7SUFDbEQsTUFBTSxLQUFLLENBQUMsS0FBSyxFQUFFLElBQUksRUFBRSxFQUFFLEdBQUcsRUFBRSxHQUFHLEVBQUUsQ0FBQyxDQUFDO0FBQ3pDLENBQUM7QUFFRCxNQUFNLENBQUMsS0FBSyxVQUFVLGFBQWEsQ0FBQyxHQUFXLEVBQUUsR0FBRyxJQUFjO0lBQ2hFLE1BQU0sTUFBTSxDQUFDLEdBQUcsRUFBRSxTQUFTLEVBQUUsR0FBRyxJQUFJLENBQUMsQ0FBQztBQUN4QyxDQUFDO0FBRUQsTUFBTSxDQUFDLEtBQUssVUFBVSxzQkFBc0IsQ0FDMUMsR0FBVyxFQUNYLElBQWMsRUFDZCxPQUFpQjtJQUVqQixNQUFNLGFBQWEsQ0FBQyxHQUFHLEVBQUUsR0FBRyxJQUFJLENBQUMsQ0FBQztJQUNsQyxNQUFNLGFBQWEsQ0FBQyxHQUFHLEVBQUUsWUFBWSxFQUFFLEdBQUcsT0FBTyxDQUFDLENBQUM7QUFDckQsQ0FBQztBQUVELElBQUksS0FBSyxHQUFHLElBQUksQ0FBQyxHQUFHLEVBQUUsQ0FBQztBQUV2QixNQUFNLENBQUMsS0FBSyxVQUFVLDBCQUEwQjtJQUM5QyxNQUFNLEdBQUcsR0FBRyxJQUFJLENBQUMsT0FBTyxDQUFDLEVBQUUsQ0FBQyxNQUFNLEVBQUUsRUFBRSx1QkFBdUIsS0FBSyxFQUFFLENBQUMsQ0FBQztJQUN0RSxLQUFLLElBQUksQ0FBQyxDQUFDO0lBQ1gsTUFBTSxFQUFFLENBQUMsUUFBUSxDQUFDLEVBQUUsQ0FBQyxHQUFHLEVBQUUsRUFBRSxTQUFTLEVBQUUsSUFBSSxFQUFFLEtBQUssRUFBRSxJQUFJLEVBQUUsQ0FBQyxDQUFDO0lBRTVELE9BQU8sR0FBRyxDQUFDO0FBQ2IsQ0FBQztBQUVELE1BQU0sQ0FBQyxLQUFLLFVBQVUsZ0JBQWdCLENBQUMsR0FBVztJQUNoRCxJQUFJLENBQUM7UUFDSCxNQUFNLE1BQU0sQ0FBQyxHQUFHLEVBQUUsS0FBSyxFQUFFLE1BQU0sQ0FBQyxDQUFDO0lBQ25DLENBQUM7SUFBQyxPQUFPLEdBQUcsRUFBRSxDQUFDO1FBQ2IsSUFBSSxHQUFHLFlBQVksU0FBUyxFQUFFLENBQUM7WUFDN0IsT0FBTyxDQUFDLEtBQUssQ0FBQyxTQUFTLEVBQUUsR0FBRyxDQUFDLE1BQU0sQ0FBQyxRQUFRLEVBQUUsQ0FBQyxDQUFDO1lBQ2hELE9BQU8sQ0FBQyxLQUFLLENBQUMsU0FBUyxFQUFFLEdBQUcsQ0FBQyxNQUFNLENBQUMsUUFBUSxFQUFFLENBQUMsQ0FBQztRQUNsRCxDQUFDO1FBQ0QsTUFBTSxHQUFHLENBQUM7SUFDWixDQUFDO0FBQ0gsQ0FBQztBQUVEOzs7Ozs7OztHQVFHO0FBQ0gsTUFBTSxDQUFDLEtBQUssVUFBVSxpQkFBaUIsQ0FDckMsR0FBVyxFQUNYLFFBQTREO0lBRTVELE1BQU0sV0FBVyxHQUFHLE1BQU0sRUFBRSxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLEdBQUcsRUFBRSxjQUFjLENBQUMsQ0FBQyxDQUFDO0lBQ3pFLE1BQU0sT0FBTyxHQUFHLE1BQU0sUUFBUSxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUFDLFNBQVMsQ0FBQyxXQUFXLENBQUMsQ0FBQyxDQUFDLENBQUM7SUFDeEUsTUFBTSxFQUFFLENBQUMsUUFBUSxDQUFDLFNBQVMsQ0FDekIsSUFBSSxDQUFDLE9BQU8sQ0FBQyxHQUFHLEVBQUUsY0FBYyxDQUFDLEVBQ2pDLElBQUksQ0FBQyxTQUFTLENBQUMsT0FBTyxFQUFFLElBQUksRUFBRSxDQUFDLENBQUMsRUFDaEMsT0FBTyxDQUNSLENBQUM7SUFDRixPQUFPLFdBQVcsQ0FBQztBQUNyQixDQUFDIn0=

package/package.json

@@ -1,17 +1,19 @@
 {
   "name": "@electron-forge/test-utils",
-  "version": "8.0.0-alpha.3",
+  "version": "8.0.0-alpha.5",
+  "type": "module",
   "description": "Helper utilities for the Electron Forge testsuite",
   "repository": "https://github.com/electron/forge",
   "author": "Mark Lee",
   "license": "MIT",
-  "main": "dist/index.js",
+  "exports": "./dist/index.js",
   "typings": "dist/index.d.ts",
   "dependencies": {
-    "@malept/cross-spawn-promise": "^2.0.0"
+    "@malept/cross-spawn-promise": "^2.0.0",
+    "fs-extra": "^10.0.0"
   },
   "engines": {
-    "node": ">= 16.4.0"
+    "node": ">= 22.12.0"
   },
   "publishConfig": {
     "access": "public"
@@ -20,5 +22,5 @@
     "dist",
     "src"
   ],
-  "gitHead": "1ac299b86edfb2173f44f885148310648db03e88"
+  "gitHead": "5ad3a256c5896637d0858d7713101bfabefb557e"
 }

package/src/index.ts

@@ -1,8 +1,16 @@
-import fs from 'node:fs';
 import os from 'node:os';
 import path from 'node:path';
 
 import { ExitError, spawn } from '@malept/cross-spawn-promise';
+import fs from 'fs-extra';
+
+export type PackageJSON = Record<string, unknown> & {
+  config?: {
+    forge?: Record<string, unknown>;
+  };
+  dependencies?: Record<string, string>;
+  devDependencies?: Record<string, string>;
+};
 
 async function runNPM(dir: string, ...args: string[]) {
   await spawn('npm', args, { cwd: dir });
@@ -44,22 +52,24 @@ export async function expectLintToPass(dir: string): Promise<void> {
 }
 
 /**
- * Helper function to mock CommonJS `require` calls with Vitest.
+ * Mutates the `package.json` file in a directory.
+ * Use the return value to later restore the original `package.json` value
+ * in a subsequent call of this function.
  *
- * @see https://github.com/vitest-dev/vitest/discussions/3134
- * @param mockedUri - mocked module URI
- * @param stub - stub function to assign to mock
+ * @param dir - The target directory containing the `package.json` file
+ * @param callback - A callback function that returns the value of the new `package.json` to be applied
+ * @returns The original `package.json` prior to mutation
  */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export async function mockRequire(mockedUri: string, stub: any) {
-  const { Module } = await import('module');
-
-  //@ts-expect-error undocumented functions
-  Module._load_original = Module._load;
-  //@ts-expect-error undocumented functions
-  Module._load = (uri, parent) => {
-    if (uri === mockedUri) return stub;
-    //@ts-expect-error undocumented functions
-    return Module._load_original(uri, parent);
-  };
+export async function updatePackageJSON(
+  dir: string,
+  callback: (packageJSON: PackageJSON) => Promise<PackageJSON>,
+) {
+  const packageJSON = await fs.readJson(path.resolve(dir, 'package.json'));
+  const mutated = await callback(JSON.parse(JSON.stringify(packageJSON)));
+  await fs.promises.writeFile(
+    path.resolve(dir, 'package.json'),
+    JSON.stringify(mutated, null, 2),
+    'utf-8',
+  );
+  return packageJSON;
 }