electron-forge does not work with yarn workspaces #869

peanutbother · 2019-05-22T12:04:49Z

I have read the contribution documentation for this project.
I agree to follow the code of conduct that this project follows, as appropriate.
I have searched the issue tracker for an issue that matches the one I want to file, without success.

Since I use Yarn workspaces electron-forge complains about missing dependencies which are installed through yarn in parent folder. My directory structure is as following:

omnicrom/
├─ node_modules/
│   ├──.bin/
│   ├── electron-forge
│   ├── electron
│   └── ...
├─ .../
└─ packages/
   └─ app/
      ├── .../
      ├── node_modules/
      │  └──.bin/
      └── src/

Console Output (with stack)

WARNING: DEBUG environment variable detected. Progress indicators will be sent over electron-forge:lifecycle electron-forge:lifecycle Process Started: Checking your system +0ms electron-forge:lifecycle Process Succeeded: Checking your system +517ms electron-forge:runtime-config setting key: verbose to value: false +0ms WARNING: DEBUG environment variable detected. Progress indicators will be sent over electron-forge:lifecycle electron-forge:lifecycle Process Started: Locating Application +0ms electron-forge:project-resolver searching for project in: D:\projects\crm\omnicrom\packages\app +0ms electron-forge:project-resolver electron-forge compatible package.json found in D:\projects\crm\omnicrom\packages\app\package.json +7ms electron-forge:lifecycle Process Succeeded: Locating Application +10ms electron-forge:util Could not read package.json for moduleName=electron-prebuilt-compile [Error: ENOENT: no such file or directory, open 'D:\projects\crm\omnicrom\packages\app\node_modules\electron-prebuilt-compile\package.json'] { errno: -4058, code: 'ENOENT', syscall: 'open', path: 'D:\\projects\\crm\\omnicrom\\packages\\app\\node_modules\\electron-prebuilt-compile\\package.json' } +0ms electron-forge:util Could not read package.json for moduleName=electron [Error: ENOENT: no such file or directory, open 'D:\projects\crm\omnicrom\packages\app\node_modules\electron\package.json'] { errno: -4058, code: 'ENOENT', syscall: 'open', path: 'D:\\projects\\crm\\omnicrom\\packages\\app\\node_modules\\electron\\package.json' } +4ms electron-forge:util Could not read package.json for moduleName=electron-prebuilt [Error: ENOENT: no such file or directory, open 'D:\projects\crm\omnicrom\packages\app\node_modules\electron-prebuilt\package.json'] { errno: -4058, code: 'ENOENT', syscall: 'open', path: 'D:\\projects\\crm\\omnicrom\\packages\\app\\node_modules\\electron-prebuilt\\package.json' } +2ms electron-forge:util getElectronVersion failed to determine Electron version: projectDir=D:\projects\crm\omnicrom\packages\app, result=null +1ms

An unhandled rejection has occurred inside Forge:
Could not determine Electron version. Make sure that 'npm install' (or 'yarn') has been run before invoking electron-forge.
Error: Could not determine Electron version. Make sure that 'npm install' (or 'yarn') has been run before invoking electron-forge.
at D:\projects\crm\omnicrom\node_modules\electron-forge\dist\util\rebuild.js:26:13
at Generator.next ()
at Generator.tryCatcher (D:\projects\crm\omnicrom\node_modules\bluebird\js\release\util.js:16:23)
at PromiseSpawn._promiseFulfilled (D:\projects\crm\omnicrom\node_modules\bluebird\js\release\generators.js:97:49)
at D:\projects\crm\omnicrom\node_modules\bluebird\js\release\generators.js:201:15
at D:\projects\crm\omnicrom\node_modules\electron-forge\dist\util\rebuild.js:63:17
at D:\projects\crm\omnicrom\node_modules\electron-forge\dist\api\start.js:105:33
at Generator.next ()
at Generator.tryCatcher (D:\projects\crm\omnicrom\node_modules\bluebird\js\release\util.js:16:23)
at PromiseSpawn._promiseFulfilled (D:\projects\crm\omnicrom\node_modules\bluebird\js\release\generators.js:97:49)
at Promise._settlePromise (D:\projects\crm\omnicrom\node_modules\bluebird\js\release\promise.js:574:26)
at Promise._settlePromise0 (D:\projects\crm\omnicrom\node_modules\bluebird\js\release\promise.js:614:10)
at Promise._settlePromises (D:\projects\crm\omnicrom\node_modules\bluebird\js\release\promise.js:694:18)
at _drainQueueStep (D:\projects\crm\omnicrom\node_modules\bluebird\js\release\async.js:138:12)
at _drainQueue (D:\projects\crm\omnicrom\node_modules\bluebird\js\release\async.js:131:9)
at Async._drainQueues (D:\projects\crm\omnicrom\node_modules\bluebird\js\release\async.js:147:5)

What command line arguments are you passing?

none.

What does your config.forge data in package.json look like?

config.forge settings

"config": {
    "forge": {
      "make_targets": {
        "win32": [
          "squirrel"
        ],
        "darwin": [
          "zip"
        ],
        "linux": [
          "deb",
          "rpm"
        ]
      },
      "electronPackagerConfig": {
        "packageManager": "yarn"
      },
      "electronWinstallerConfig": {
        "name": "omnicrom"
      },
      "electronInstallerDebian": {},
      "electronInstallerRedhat": {},
      "github_repository": {
        "owner": "",
        "name": ""
      },
      "windowsStoreConfig": {
        "packageName": "",
        "name": "omnicrom"
      }
    }
  }

To recreate this issue simply create a new project with electron-forge and then wrap it into a yarn workspace. to do this you refer to this guide: https://yarnpkg.com/en/docs/workspaces
You could also recreate my directory structure and use the following root package.json contents:

{
  "name": "myrootpackage",
  "version": "1.0.0",
  "private": true,
  "workspaces": [
    "packages/*"
  ]
}

The text was updated successfully, but these errors were encountered:

malept · 2019-05-22T14:45:07Z

Can you try Electron Forge v6? (That version is more likely to get a fix for this.)

malept · 2019-05-22T15:25:41Z

Yeah, that's probably not going to work either. Yarn workspaces function differently than lerna (and bolt, which Forge uses) in that there's only one node_modules folder instead of one per package. I think what needs to happen is that if there's no node_modules folder in the app directory and the package manager that Forge detects is yarn, it needs to search for a yarn.lock and use that directory to find the Electron module.

peanutbother · 2019-05-22T15:38:02Z

Can you try Electron Forge v6? (That version is more likely to get a fix for this.)

This doesn't work either as you pointed out already.

Yarn workspaces function differently than lerna

I don't know about bolt, but lerna supports yarn workspaces so that could create the same issue once one tries to enable them.

I think what needs to happen is that if there's no node_modules folder in the app directory and the package manager that Forge detects is yarn, it needs to search for a yarn.lock and use that directory to find the Electron module.

yarn.lock is generated in each yarn workspace folder.
it woul be mroe reliable to test if node_modules is empty besides the .bin folder and walk the directories up until it finds a folder with package.json which has private:true and contains the node_modules folder with all dependencies

malept · 2019-05-22T15:41:49Z

lerna supports yarn workspaces so that could create the same issue once one tries to enable them.

I ran lerna init / lerna create to get the default behavior. It doesn't really matter here if it "supports" yarn workspaces if we're going to be adding support for it anyway.

yarn.lock is generated in each yarn workspace folder.

That's not what I'm seeing in my tests. yarn.lock only exists in the top-level of the monorepo.

Yarn: 1.16.0, Linux

peanutbother · 2019-05-22T15:45:27Z

That's not what I'm seeing in my tests. yarn.lock only exists in the top-level of the monorepo.

Alright that was my mistake, shame on me. I left the lock file after migration to a monorepo.

we're going to be adding support for it anyway.

That's great to hear! Let me know if I can help in these tasks.

malept · 2019-06-12T04:36:15Z

So I have a fix for this particular issue, but I can guarantee that this will not work out-of-the-box once you get to the package phase. I've made several comments on this topic in electron/packager#774. TL;DR: you'll need to add a Packager afterCopy hook to run yarn install --production in the app directory.

alxmiron · 2020-03-18T11:22:50Z

Had the same problem. Fixed this by moving electron package from ./node_modules to ./packages/app/node_modules using yarn workspaces.noihoist

peanutbother · 2020-03-18T11:49:33Z

Thanks for the suggestion!
I will try this when I get back to my project.

abumalick · 2020-03-19T15:42:48Z

symlinking the node_modules folder worked for me
ln -s ../node_modules electron_app/node_modules

Not sure about the build and everything through

malept · 2020-03-19T15:54:31Z

This was fixed in Electron Forge v6.

abumalick · 2020-03-19T17:15:01Z

Mmmh, I am using 6.0.0-beta.50

It bugged with my simple symlink in the end, I used @alxmiron 's solution with noihoist. It is working well

"workspaces": {
    "packages": [
      "app",
      "server"
    ],
    "nohoist": [
      "**/electron**"
    ]
  },

malept · 2020-03-19T17:53:32Z

Is this yarn 1 or 2?

abumalick · 2020-03-19T18:05:01Z

yarn --version                           
1.22.0

I am using the typescript template https://www.electronforge.io/templates/typescript-template. I think it is webpack that is causing problem. I am having problems with other modules when loaded by webpack.

abumalick · 2020-03-19T18:05:35Z

I can make a reproduction repository if it is useful for you

malept · 2020-03-19T18:07:18Z

I can make a reproduction repository if it is useful for you

It would be helpful to have a minimal testcase, yes.

abumalick · 2020-03-19T18:23:47Z

I was using typescript-webpack template, my bad.

Here is a reproduction repository:
https://github.com/abumalick/electron-forge-workspace-bug

abumalick · 2020-03-19T18:25:21Z

Feel free to tell me if you need any other information

abumalick · 2020-03-19T18:38:38Z

I ended up adding

"nohoist": [
      "**"
    ]

I tried to add express package and I get a lot of problems with the workspaces

alxmiron · 2020-03-20T20:02:33Z

@abumalick has correct testcase - I also get an error "electron package not found" there, unless I add the following props to my-new-app/package.json:

"private": true,
"workspaces": {
  "nohoist": [
    "electron",
    "electron/**",
    "electron-squirrel-startup",
    "electron-squirrel-startup/**",
    "@electron-forge",
    "@electron-forge/**"
  ]
},

NOTE: "private": true is important

beorn · 2021-03-27T23:33:34Z

Using "nohoist" is more of a workaround than a real solution. 🙁

airtonix · 2021-05-02T01:31:37Z

Yeah using nohoist isn't viable in monorepos that contain more than one app.

what ends up happening is the install time ballons, the diskspace taken ballons.

The only long term viable solution is to change whatever logic it is that makes assumptions about where the electron package is.

i mean... just use the normal node resolver.

This is a huge problem in react-native too.

Eli-Black-Work · 2021-05-26T02:19:04Z

Thanks for the hints about nohoist 🙂

In the latest version of Yarn Berry (2.4.1?), nohoist has been deprecated in favor of nmHoistingLimits. See Replace nohoist by nmHoistingLimits for more details.

In our case, this meant removing nohoist and putting the following line into our .yarnrc.yml file:

nmHoistingLimits: workspaces

Note that that line goes in .yarnrc.yml, not package.json (although there's supposed to be a way to specify nmHoistingLimits via package.json, too).

After this, everything worked 🙂

Eli-Black-Work · 2021-07-27T10:07:03Z

It looks like this has been fixed in the latest version (6.0.0-beta.59)! ^_^

sibelius · 2023-11-28T00:38:38Z

can we have electron forget without nohoist?

johnnybenson · 2024-08-06T14:19:37Z

Had the same problem. Fixed this by moving electron package from ./node_modules to ./packages/app/node_modules using yarn workspaces.noihoist

    "workspaces": {
        "packages": [
            "apps/*",
            "packages/ts/*"
        ],
        "nohoist": [
            "**/electron"
        ]
    },

yarn --version
1.22.22

Hopefully save someone a minute running around, nohoist looks like this in the root package.json

malept added the bug label May 22, 2019

malept mentioned this issue Jun 1, 2019

fix: search for the top-level node_modules folder when using yarn workspaces #902

Merged

5 tasks

malept closed this as completed in #902 Jun 12, 2019

kamontat mentioned this issue Dec 31, 2019

start does not work with yarn workspaces #1377

Closed

3 tasks

ADustyOldMuffin mentioned this issue Jul 1, 2020

yarn create electron-app my-app says **Error: Cannot find module 'source-map-support/register'** #1681

Closed

3 tasks

DerekZiemba mentioned this issue Sep 2, 2020

Feedback for Yarn 2 Setup DerekZiemba/yarn-V2-workspaces-simple-monorepo#1

Open

mangnus mentioned this issue Jun 4, 2021

electron-forge does not work with npm workspaces (npm v7) #2306

Closed

3 tasks

snyk-bot mentioned this issue Sep 16, 2021

[Snyk] Fix for 1 vulnerabilities maniator/electron-forge#5

Open

dan-fritchman mentioned this issue Nov 17, 2022

Tracking all the electron-forge things Vlsir/Hdl21Schematics#24

Open

dsanders11 pushed a commit that referenced this issue Jan 14, 2023

fix: delete gist files on update (#869)

b06713d

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

electron-forge does not work with yarn workspaces #869

electron-forge does not work with yarn workspaces #869

peanutbother commented May 22, 2019 •

edited by malept

Loading

malept commented May 22, 2019

malept commented May 22, 2019

peanutbother commented May 22, 2019

malept commented May 22, 2019

peanutbother commented May 22, 2019 •

edited

Loading

malept commented Jun 12, 2019

alxmiron commented Mar 18, 2020

peanutbother commented Mar 18, 2020

abumalick commented Mar 19, 2020

malept commented Mar 19, 2020

abumalick commented Mar 19, 2020

malept commented Mar 19, 2020

abumalick commented Mar 19, 2020

abumalick commented Mar 19, 2020

malept commented Mar 19, 2020

abumalick commented Mar 19, 2020

abumalick commented Mar 19, 2020

abumalick commented Mar 19, 2020

alxmiron commented Mar 20, 2020

beorn commented Mar 27, 2021

airtonix commented May 2, 2021 •

edited

Loading

Eli-Black-Work commented May 26, 2021

Eli-Black-Work commented Jul 27, 2021

sibelius commented Nov 28, 2023

johnnybenson commented Aug 6, 2024

electron-forge does not work with yarn workspaces #869

electron-forge does not work with yarn workspaces #869

Comments

peanutbother commented May 22, 2019 • edited by malept Loading

malept commented May 22, 2019

malept commented May 22, 2019

peanutbother commented May 22, 2019

malept commented May 22, 2019

peanutbother commented May 22, 2019 • edited Loading

malept commented Jun 12, 2019

alxmiron commented Mar 18, 2020

peanutbother commented Mar 18, 2020

abumalick commented Mar 19, 2020

malept commented Mar 19, 2020

abumalick commented Mar 19, 2020

malept commented Mar 19, 2020

abumalick commented Mar 19, 2020

abumalick commented Mar 19, 2020

malept commented Mar 19, 2020

abumalick commented Mar 19, 2020

abumalick commented Mar 19, 2020

abumalick commented Mar 19, 2020

alxmiron commented Mar 20, 2020

beorn commented Mar 27, 2021

airtonix commented May 2, 2021 • edited Loading

Eli-Black-Work commented May 26, 2021

Eli-Black-Work commented Jul 27, 2021

sibelius commented Nov 28, 2023

johnnybenson commented Aug 6, 2024

peanutbother commented May 22, 2019 •

edited by malept

Loading

peanutbother commented May 22, 2019 •

edited

Loading

airtonix commented May 2, 2021 •

edited

Loading