feat: allow a custom out dir from forge config

[jeanbmar]

• I have read the contribution documentation for this project.
• I agree to follow the code of conduct that this project follows, as appropriate.
• The changes are appropriately documented (if applicable).
• The changes have sufficient test coverage (if applicable).
• The testsuite passes successfully on my local machine (if applicable).

Summarize your changes:

This PR allows using a custom outDir when packaging and making an app.
A new top-level outDir optional string property is added to the forgeConfig object to do so.

This PR aims to:

• help people who don't like (or are not allowed) to mix binaries with code
• help Windows users to manage the electron-winstaller Squirrel infamous issue with long paths since files can be relocated easily
• help monorepo users who can't use asar to solve the long path issue because of symlink issues (which should anyway be a design decision)

Related issues:

• Configure executable output directory. #1041
• Custom outDir #214
• electron-winstaller only gives the error "the path specified, the file name or both are too long." windows-installer#219
• long node_module paths cause problem - any ideas? windows-installer#301

[VerteDinde]

@jeanbmar In general, I'm fine with this change! Could we please add some test coverage for the custom outDir option here? A good place to add them would be here: https://github.com/electron-userland/electron-forge/blob/master/packages/api/core/test/fast/forge-config_spec.ts

[VerteDinde]

Moving this to "request changes" - please add tests here! 🙂

[jeanbmar]

Hey, will do when i can find some time for it :)

[adminy]

electron/packager#1460

This issue actually started off as electron forge issue.

An unhandled rejection has occurred inside Forge:
Error: The main entry point to your app was not found. Make sure "/home/magic/out/main/index.js" exists and does not get ignored by your ignore option
at Object.validateElectronApp (/home/magic/node_modules/electron-packager/src/common.js:115:13)
    at async MacApp.buildApp (/home/magic/node_modules/electron-packager/src/platform.js:135:5)
    at async MacApp.initialize (/home/magic/node_modules/electron-packager/src/platform.js:127:7)
    at async MacApp.create (/home/magic/node_modules/electron-packager/src/mac.js:377:5)
    at async Promise.all (index 0)
    at async packager (/home/magic/node_modules/electron-packager/src/index.js:204:20)

But maybe if that one can be fixed soon, this PR could come in handy.

[akash07k]

Is there any plan to merge this PR anytime soon?

[AlexDev404]

Is there any plan to merge this PR anytime soon?

Yeah, someone (or @jeanbmar ) just needs to add some tests to it first it seems 😕

[akash07k]

Oh, ok :(

Is there any plan to merge this PR anytime soon?

Yeah, someone (or @jeanbmar ) just needs to add some tests to it first it seems 😕

[jeanbmar]

Sorry I've moved on and won't implement the missing tests. On the other hand interfaces are unchanged with this PR so I don't see why additional tests would be relevant.

[lutzroeder]

Duplicate of #3458

[dsanders11]

Closing as #3458 has picked up the discussion on this.