feat: esm forge.config.js support

[mahnunchik]

• 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 tiny PR adds ESM config support. Test added. Closes #3350

It is not a breaking change. Be ready for Electron 28 with ESM support! 💯

[mahnunchik]

Of course, I understand that it is better to (1) update typescript (2) update target to esnext, (3) update module resolution to esnext too (4) replace interpret and rechoir with something working with esm but this small fix allow to use ESM config without such big changes 😉

[mahnunchik]

I think the failing Windows tests are not related to the changes.

[mahnunchik]

Related #3129

[MarshallOfSound]

We cant ship code that depends on string templated eval, that's neither safe nor generally good practice

[mahnunchik]

@MarshallOfSound maybe you know how to make quite old typescript to not compile dynamic import?

Or if you plan to upgrade typescript and compiled module type it should be pretty easy.

[MarshallOfSound]

Make a plain JS file that exports a helper that uses the dynamic import method. Not pretty but better than eval imo

[mahnunchik]

@MarshallOfSound if dynamic import is in js file it is compiled to require.... I need help to figure it out.

return Promise.resolve().then(() => __importStar(require(path)));

[mahnunchik]

@MarshallOfSound I think I was able to get it to work with the current version of ts. Could you please check the current implementation?

[mahnunchik]

Windows tests are fixed!

[mahnunchik]

@MarshallOfSound @erikian @erickzhao what can I do to ship this feature?

[mahnunchik]

@MarshallOfSound @erikian @erickzhao it is me again 😉 What should I do to ship this feature?

[himself65]

hi, what's the update on this progress?

[Jayatubi]

Looks like it doesn't work with forge.config.ts.

The dynamicImport would fail with ts version config path and esm on:

code:
'ERR_UNKNOWN_FILE_EXTENSION'
message:
'Unknown file extension ".ts" for E:\project\forge.config.ts'

[felipecrs]

I must be crazy or something, but I am trying to convert my forget.config.js to ESM today with electron-forge 7.4.0 and I am getting:

$ npx electron-forge package
✔ Checking your system
✖ Preparing to package application
  › require() of ES Module C:\Users\felip\repos\clipboard-sync\forge.config.js from
  C:\Users\felip\repos\clipboard-sync\node_modules\@electron-forge\core\dist\util\forge-config.js not supported.     
  Instead change the require of forge.config.js in
  C:\Users\felip\repos\clipboard-sync\node_modules\@electron-forge\core\dist\util\forge-config.js to a dynamic       
  import() which is available in all CommonJS modules.
◼ Running packaging hooks
◼ Packaging application
◼ Running postPackage hook

Failed to load: C:\Users\felip\repos\clipboard-sync\forge.config.js

An unhandled rejection has occurred inside Forge:
Error [ERR_REQUIRE_ESM]: require() of ES Module C:\Users\felip\repos\clipboard-sync\forge.config.js from C:\Users\felip\repos\clipboard-sync\node_modules\@electron-forge\core\dist\util\forge-config.js not supported.
Instead change the require of forge.config.js in C:\Users\felip\repos\clipboard-sync\node_modules\@electron-forge\core\dist\util\forge-config.js to a dynamic import() which is available in all CommonJS modules.
at exports.default (C:\Users\felip\repos\clipboard-sync\node_modules\@electron-forge\core\dist\util\forge-config.js:140:26)
    at async C:\Users\felip\repos\clipboard-sync\node_modules\@electron-forge\core\dist\api\package.js:80:35
    at async _Task.taskFn (C:\Users\felip\repos\clipboard-sync\node_modules\@electron-forge\tracer\dist\index.js:58:20)
    at async _Task.run (C:\Users\felip\repos\clipboard-sync\node_modules\listr2\dist\index.cjs:2063:11)

Am I missing something?

[felipecrs]

I see now. The loader blindly ignores all errors when trying to import my config and then fallbacks to requiring.

I had an error in my config, therefore it was entering in the fallback.

[felipecrs]

Just in case others stumble upon this:

I had to change:

import MakerSquirrel from "@electron-forge/maker-squirrel";

To:

import { MakerSquirrel } from "@electron-forge/maker-squirrel";