feat(init)!: add --package-manager flag

package.json

@@ -19,12 +19,13 @@
     "lint": "npm run lint:js && npm run lint:markdown && npm run lint:markdown-js && npm run lint:markdown-links",
     "lint:fix": "prettier --write . --experimental-cli && eslint --fix . --cache",
     "prepack": "yarn build",
-    "test": "xvfb-maybe vitest run --project fast --project slow",
+    "test": "xvfb-maybe vitest run --project fast --project slow --project slow-verdaccio",
     "test:fast": "xvfb-maybe vitest run --project fast",
     "test:slow": "xvfb-maybe vitest run --project slow",
     "test:verdaccio": "tsx tools/verdaccio/spawn-verdaccio.ts xvfb-maybe vitest run --project slow-verdaccio",
     "test:clear": "tsx tools/test-clear",
-    "postinstall": "husky install && node -e \"try { fs.rmSync('node_modules/.bin/*.ps1', { recursive: true, force: true }) } catch (e) {}\" && tsx ./tools/gen-tsconfigs.ts && tsx ./tools/gen-ts-glue.ts"
+    "postinstall": "husky install && node -e \"try { fs.rmSync('node_modules/.bin/*.ps1', { recursive: true, force: true }) } catch (e) {}\" && tsx ./tools/gen-tsconfigs.ts && tsx ./tools/gen-ts-glue.ts",
+    "spawn-verdaccio": "tsx tools/verdaccio/spawn-verdaccio.ts"
   },
   "dependencies": {
     "@aws-sdk/client-s3": "^3.654.0",

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

@@ -33,6 +33,10 @@ program
     '--electron-version [version]',
     'Set a specific Electron version for your Forge project. Can take in a version string (e.g. `38.3.0`) or `latest`, `beta`, or `nightly` tags.',
   )
+  .option(
+    '--package-manager [name]',
+    'Set a specific package manager to use for your Forge project. Supported package managers are `npm`, `pnpm`, and `yarn`. You can also specify an exact version to use (e.g. `yarn@1.22.22`).',
+  )
   .action(async (dir) => {
     const options = program.opts();
     const tasks = new Listr<InitOptions>(
@@ -46,11 +50,11 @@ program
             initOpts.skipGit = Boolean(options.skipGit);
             initOpts.dir = resolveWorkingDir(dir, false);
             initOpts.electronVersion = options.electronVersion ?? 'latest';
+            initOpts.packageManager = options.packageManager ?? 'npm@latest';
           },
         },
         {
           task: async (initOpts, task): Promise<void> => {
-            // only run interactive prompts if no args passed and not in CI environment
             if (
               Object.keys(options).length > 0 ||
               process.env.CI ||
@@ -79,6 +83,18 @@ program
               }
             }
 
+            const packageManager: string = await prompt.run<
+              Prompt<string, any>
+            >(select, {
+              message: 'Select a package manager',
+              choices: [
+                { name: 'npm', value: 'npm@latest' },
+                { name: 'pnpm', value: 'pnpm@latest' },
+                { name: 'Yarn (Berry)', value: 'yarn@latest' },
+                { name: 'Yarn (Classic)', value: 'yarn@1' },
+              ],
+            });
+
             const bundler: string = await prompt.run<Prompt<string, any>>(
               select,
               {
@@ -121,6 +137,7 @@ program
               );
             }
 
+            initOpts.packageManager = packageManager;
             initOpts.template = `${bundler}${language ? `-${language}` : ''}`;
 
             // TODO: add prompt for passing in an exact version as well

packages/api/core/spec/slow/init.slow.verdaccio.spec.ts

@@ -214,18 +214,11 @@ describe('init', () => {
   describe('package managers', () => {
     describe('with npm', () => {
       beforeAll(() => {
-        const originalPM = process.env.NODE_INSTALLER;
-        process.env.NODE_INSTALLER = 'npm';
-
         process.env.COREPACK_ENABLE_STRICT = '0';
-
-        return () => {
-          process.env.NODE_INSTALLER = originalPM;
-        };
       });
 
       it('initializes with package-lock.json', async () => {
-        await api.init({ dir });
+        await api.init({ dir, packageManager: 'npm' });
 
         expect(fs.existsSync(path.join(dir, 'package-lock.json'))).toBe(true);
         expect(fs.existsSync(path.join(dir, 'yarn.lock'))).toBe(false);
@@ -236,15 +229,8 @@ describe('init', () => {
     // NOTE: we basically run all tests via Yarn Berry anyways
     // due to the `packageManager` entry in this monorepo.
     describe('with yarn (berry)', () => {
-      beforeAll(() => {
-        const originalPM = process.env.NODE_INSTALLER;
-        process.env.NODE_INSTALLER = 'yarn';
-        return () => {
-          process.env.NODE_INSTALLER = originalPM;
-        };
-      });
       it('initializes with correct nodeLinker value', async () => {
-        await api.init({ dir });
+        await api.init({ dir, packageManager: 'yarn@4.10.3' });
 
         expect(
           fs.readFileSync(path.join(dir, '.yarnrc.yml'), 'utf-8'),
@@ -270,19 +256,12 @@ describe('init', () => {
 
     describe('with pnpm', () => {
       beforeAll(() => {
-        const originalPM = process.env.NODE_INSTALLER;
-        process.env.NODE_INSTALLER = 'pnpm';
-
         // disable corepack strict to allow pnpm to be used
         process.env.COREPACK_ENABLE_STRICT = '0';
-
-        return () => {
-          process.env.NODE_INSTALLER = originalPM;
-        };
       });
 
       it('initializes with correct node-linker value', async () => {
-        await api.init({ dir });
+        await api.init({ dir, packageManager: 'pnpm' });
 
         expect(fs.readFileSync(path.join(dir, '.npmrc'), 'utf-8')).toContain(
           'node-linker = hoisted',

packages/api/core/src/api/init.ts

@@ -2,6 +2,7 @@ import path from 'node:path';
 
 import { PMDetails, resolvePackageManager } from '@electron-forge/core-utils';
 import { ForgeTemplate } from '@electron-forge/shared-types';
+import { spawn } from '@malept/cross-spawn-promise';
 import chalk from 'chalk';
 import debug from 'debug';
 import { Listr } from 'listr2';
@@ -54,6 +55,10 @@ export interface InitOptions {
    * @defaultValue The `latest` tag on npm.
    */
   electronVersion?: string;
+  /**
+   * Force a package manager to use (npm|yarn|pnpm).
+   */
+  packageManager?: string;
 }
 
 async function validateTemplate(
@@ -84,6 +89,7 @@ export default async ({
   template = 'base',
   skipGit = false,
   electronVersion = 'latest',
+  packageManager,
 }: InitOptions): Promise<void> => {
   d(`Initializing in: ${dir}`);
 
@@ -96,8 +102,8 @@ export default async ({
       {
         title: `Resolving package manager`,
         task: async (ctx, task) => {
-          ctx.pm = await resolvePackageManager();
-          task.title = `Resolving package manager: ${chalk.cyan(ctx.pm.executable)} v${ctx.pm.version}`;
+          ctx.pm = await resolvePackageManager(packageManager);
+          task.title = `Resolved package manager: ${chalk.cyan(`${ctx.pm.executable}@${ctx.pm.version}`)}`;
         },
       },
       {
@@ -169,6 +175,24 @@ export default async ({
           }
         },
       },
+      {
+        title: `Setting package manager with Corepack`,
+        // pm.executable needs to be optional here because the code gets evaluated twice (on init and on execution)
+        // @see https://listr2.kilic.dev/task/enable.html
+        enabled: ({ pm }) => pm?.executable !== 'npm',
+        task: async ({ pm }, task) => {
+          const pmString = `${pm.executable}@${pm.version}`;
+          try {
+            await spawn('corepack', ['use', pmString], {
+              cwd: dir,
+            });
+            task.title = `Set ${chalk.cyan(pmString)} via Corepack`;
+          } catch (e) {
+            d('corepack failed to run with error', e);
+            task.title = `Forge was unable to set ${chalk.cyan(pmString)} via Corepack and will fall back to ${chalk.cyan('npm')}. If you are using Node.js >= 25, you will need to install corepack via ${chalk.green('npm install -g corepack')}. Otherwise, you may need to enable Corepack shims via ${chalk.green('corepack enable')}.`;
+          }
+        },
+      },
       {
         title: 'Installing template dependencies',
         task: async ({ templateModule }, task) => {

packages/template/base/src/BaseTemplate.ts

@@ -76,7 +76,7 @@ export class BaseTemplate implements ForgeTemplate {
             // Support Yarn 2+ by default by initializing with nodeLinker: node-modules
             pm.executable === 'yarn' &&
             pm.version &&
-            semver.gte(pm.version, '2.0.0')
+            (pm.version === 'latest' || semver.gte(pm.version, '2.0.0'))
           ) {
             rootFiles.push('_yarnrc.yml');
           }
@@ -145,13 +145,6 @@ export class BaseTemplate implements ForgeTemplate {
       packageJSON.pnpm = {
         onlyBuiltDependencies: ['electron', 'electron-winstaller'],
       };
-    } else if (
-      pm.executable === 'yarn' &&
-      typeof pm.version === 'string' &&
-      semver.gte(pm.version, '2.0.0')
-    ) {
-      d('Detected Yarn 2+, adding packageManager field to package.json');
-      packageJSON.packageManager = `yarn@${pm.version}`;
     }
 
     packageJSON.scripts.lint = 'echo "No linting configured"';

packages/utils/core-utils/spec/electron-version.spec.ts

@@ -117,8 +117,11 @@ describe('getElectronVersion', () => {
   });
 
   describe('with yarn workspaces', () => {
+    let originalUserAgent: string | undefined;
     beforeAll(() => {
-      process.env.NODE_INSTALLER = 'yarn';
+      originalUserAgent = process.env.npm_config_user_agent;
+      process.env.npm_config_user_agent =
+        'yarn/1.22.22 npm/? node/v22.13.0 darwin arm64';
     });
 
     it('works with a non-exact version', async () => {
@@ -139,7 +142,7 @@ describe('getElectronVersion', () => {
     });
 
     afterAll(() => {
-      delete process.env.NODE_INSTALLER;
+      process.env.npm_config_user_agent = originalUserAgent;
     });
   });
 });
@@ -213,12 +216,15 @@ describe('getElectronModulePath', () => {
   });
 
   describe('with yarn workspaces', () => {
+    let originalUserAgent: string | undefined;
     beforeAll(() => {
-      process.env.NODE_INSTALLER = 'yarn';
+      originalUserAgent = process.env.npm_config_user_agent;
+      process.env.npm_config_user_agent =
+        'yarn/1.22.22 npm/? node/v22.13.0 darwin arm64';
     });
 
     afterAll(() => {
-      delete process.env.NODE_INSTALLER;
+      process.env.npm_config_user_agent = originalUserAgent;
     });
 
     it('finds the top-level electron module', async () => {