@electron-forge/maker-squirrel/src/MakerSquirrel.ts

Squirrel maker for Electron Forge

import os from 'node:os';
import path from 'node:path';

import { MakerBase, MakerOptions } from '@electron-forge/maker-base';
import { ForgePlatform } from '@electron-forge/shared-types';
import {
  convertVersion,
  createWindowsInstaller,
  Options as ElectronWinstallerOptions,
} from 'electron-winstaller';
import fs from 'fs-extra';

export type MakerSquirrelConfig = Omit<
  ElectronWinstallerOptions,
  'appDirectory' | 'outputDirectory'
>;

export default class MakerSquirrel extends MakerBase<MakerSquirrelConfig> {
  name = 'squirrel';

  defaultPlatforms: ForgePlatform[] = ['win32'];

  isSupportedOnCurrentPlatform(): boolean {
    return (
      this.isInstalled('electron-winstaller') &&
      !process.env.DISABLE_SQUIRREL_TEST
    );
  }

  async make({
    dir,
    makeDir,
    targetArch,
    packageJSON,
    appName,
    forgeConfig,
  }: MakerOptions): Promise<string[]> {
    const outPath = path.resolve(makeDir, `squirrel.windows/${targetArch}`);
    await this.ensureDirectory(outPath);

    const tmpFolder = await fs.mkdtemp(
      path.resolve(os.tmpdir(), 'squirrel-maker-'),
    );

    await fs.copy(dir, tmpFolder);

    try {
      const winstallerConfig: ElectronWinstallerOptions = {
        name:
          typeof packageJSON.name === 'string'
            ? packageJSON.name.replace(/-/g, '_')
            : undefined, // squirrel hates hyphens
        title: appName,
        noMsi: true,
        exe: `${forgeConfig.packagerConfig.executableName || appName}.exe`,
        setupExe: `${appName}-${packageJSON.version} Setup.exe`,
        ...this.config,
        appDirectory: tmpFolder,
        outputDirectory: outPath,
      };

      await createWindowsInstaller(winstallerConfig);

      const nupkgVersion = convertVersion(packageJSON.version);

      const artifacts = [
        path.resolve(outPath, 'RELEASES'),
        path.resolve(
          outPath,
          winstallerConfig.setupExe || `${appName}Setup.exe`,
        ),
        path.resolve(
          outPath,
          `${winstallerConfig.name}-${nupkgVersion}-full.nupkg`,
        ),
      ];
      const deltaPath = path.resolve(
        outPath,
        `${winstallerConfig.name}-${nupkgVersion}-delta.nupkg`,
      );
      if (
        winstallerConfig.remoteReleases &&
        !winstallerConfig.noDelta &&
        (await fs.pathExists(deltaPath))
      ) {
        artifacts.push(deltaPath);
      }
      const msiPath = path.resolve(
        outPath,
        winstallerConfig.setupMsi || `${appName}Setup.msi`,
      );
      if (!winstallerConfig.noMsi && (await fs.pathExists(msiPath))) {
        artifacts.push(msiPath);
      }
      return artifacts;
    } finally {
      await fs.remove(tmpFolder);
    }
  }
}

export { MakerSquirrel };