MakerDMG config requiring appPath even thought it is never used in typescript project

[eXhumer]

Pre-flight checklist

• I have read the contribution documentation for this project.
• I agree to follow the code of conduct that this project uses.
• I have searched the issue tracker for a bug that matches the one I want to file, without success.

Electron Forge version

7.5.0

Electron version

v32.1.1

Operating system

macOS 15.1 Beta (24B5046f)

Last known working Electron Forge version

7.4.0

Expected behavior

Being able to create a DMG installer without having to specify a fake appPath in config needing to satisfy type check.

Actual behavior

Additional config property appPath being needed to add to the config to satisfy type check. This appPath is never used for anything other than to satisfy the type check as appPath is always overridden in the make method.

forge/packages/maker/dmg/src/MakerDMG.ts

Line 29 in 420458b

appPath: path.resolve(dir, `${appName}.app`),

Steps to reproduce

1. Add @electron-forge/[email protected] to package.json in a typescript forge project.
2. Add MakerDMG to forge.config.ts with empty config object, typescript will complain about appPath not being present.

Additional information

875ee54 upgraded electron-installer-dmg from 4.0.0 to 5.0.1.

MakerDMGConfig was modified to extend ElectronInstallerDMGOptions from electron-installer-dmg, which requires appPath by default to be included in the config.

[hichemfantar]

same issue here and it's not documented https://js.electronforge.io/interfaces/_electron_forge_maker_dmg.MakerDMGConfig.html

@MarshallOfSound do you think you can take a look at this? because i'm trying to modify the installer icon but i'm being forced to specify an app path

[nikwen]

Seeing this, too.

Workaround:

    // @ts-expect-error - https://github.com/electron/forge/issues/3712
    new MakerDMG({
      icon: "./my/path",
    }),

This can probably be fixed by applying the same logic that was applied to the name attribute here:

forge/packages/maker/dmg/src/Config.ts

Line 38 in 37a66f2

export type MakerDMGConfig = Omit<ElectronInstallerDMGOptions, 'name'> & { name?: string };