feat(core): support bun as a package manager

[laynef]

Current Behavior

Expected Behavior

Related Issue(s)

Fixes #

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
nx-dev	✅ Ready (Inspect)	Visit Preview	Mar 22, 2024 9:09pm

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 85a0eef. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

---

✅ Successfully ran 6 targets

• nx affected --targets=e2e,e2e-ci --base=da12d87b183e3096b7289dabf018fa14ff66a61e --head=85a0eefd2a635a6884f2ae2b7a447c99bebd2d0c --parallel=1
• nx affected --targets=lint,test,build --base=da12d87b183e3096b7289dabf018fa14ff66a61e --head=85a0eefd2a635a6884f2ae2b7a447c99bebd2d0c --parallel=3
• nx run-many -t check-imports check-commit check-lock-files check-codeowners documentation --parallel=1 --no-dte
• nx-cloud record -- nx format:check --base=da12d87b183e3096b7289dabf018fa14ff66a61e --head=85a0eefd2a635a6884f2ae2b7a447c99bebd2d0c
• nx documentation --no-dte
• nx affected -t e2e-macos --parallel=1 --base=da12d87b183e3096b7289dabf018fa14ff66a61e --head=85a0eefd2a635a6884f2ae2b7a447c99bebd2d0c

---

Sent with 💌 from NxCloud.

[laynef]

This is the bare minimum required to support Bun.js

@JamesHenry please take a look again. Some changes are required to get that green check with minimal effort. The file changes are as minimal as the CI checks will allow.

I can't cut all the things you want.
You want me to cut too much.
The CI will not allow it.

Please pass this through for Bun.js support on NX! 🚀

[laynef]

FYI I have updated the PR title to better match our conventions

👍

[laynef]

@JamesHenry I removed the git hook file. Reverted it.
My apologizes, confusion on two different GitHub views.... My answer was incorrect and I apologize.

[laynef]

It's green again. This would be greatly appreciated if we could merge and make a new release.

[laynef]

It's building and passing. Please support this!

[laynef]

@JamesHenry It is my birthday today! 🎂 🎈
What ever you need to get this merged for the Bun.js community, I'd appreciate you a lot for that green check!

[JamesHenry]

Please revert this, I did not ask you to remove the existing comment. I asked you to remove the copy of this comment you added fresh in your PR

[JamesHenry]

@laynef Happy Birthday!

I can appreciate your enthusiasm in wanting to land this great feature, but we need to take a measured approach.

So far all we have been able to really focus on is reverting the many changes you made to the codebase that are unrelated to supporting bun.

Once we are at the point where the PR no longer contains unnecessary refactors and changes, then we will need to add e2e test coverage for bun usage for Nx. We will not land major features in Nx without adding high quality e2e tests.

For the e2e tests, we will definitely need updates to e2e/workspace-create/src/create-nx-workspace.test.ts to cover creating new Nx workspaces with bun as the package manager, you can see previous examples with other package managers. However I will also speak to the team about potential other scenarios we would want to capture in new tests.

Thanks for a the hard work, and I will continue to help you get this over the line, but please respect my requests for you to revert unrelated to changes and compare your local behaviour to the CI and master branch. I think there are some issues with your local setup somehow that are causing things to behave differently.

[JamesHenry]

@laynef Speaking of your local set up and things behaving differently - are you running things through bun all the time? Maybe that's the issue?

Please try setting up your environment and running all commands per the https://github.com/nrwl/nx/blob/54d47805de2803de183ab1dee6e05e161efc6d41/CONTRIBUTING.md and see if things improve for you and let me know

[edbzn]

Hi, I just wanted to bring up that we should be careful with Nx features relying on the package manager, I remember facing issues with those when we upgraded Yarn to v4, so it's probably better to check that those features are working well with Bun. Here are the features I think about:

• generatePackageJson option from webpack, remix, and other executors
• generateLockfile option from js tsc, swc, and other executors

Regarding the lockfile, Bun has the capability to produce a lockfile in the Yarn format, a format already compatible with Nx. See the related docs.

[JamesHenry]

Thank you @edbzn, great callouts!

[JamesHenry]

I've spoken with the team and, in addition to the above comments, the major piece missing from this PR right now is the lock file parsing needed to truly support bun as a package manager.

You will need to add to the packages/nx/src/plugins/js/lock-file section of the codebase (where you can see existing parsers for the other package managers) and add an entry for bun.

Bun has a binary lockfile format, so you will not be able to parse it directly. My understanding is that we will instead want to run bun bun.lockb in a child process and capture the text representation of its output. Given, based on the bun docs, this should be compatible with the yarn v1 lock file format, we should hopefully be able to reuse a lot of the existing work done for yarn.

I also just want to add an overall disclaimer to this PR (particularly as I see you posting screenshots of running tasks via bun run):

It is only adding bun as an available package manager. It is not not handling full runtime support (e.g. the internals of how scripts are executed). Those will still be handled by node as of this PR.

Full runtime support can be handled in a follow up once this PR to complete bun package manager support goes in.

Hopefully that's all clear for now! Thanks again

[laynef]

Hi, I just wanted to bring up that we should be careful with Nx features relying on the package manager, I remember facing issues with those when we upgraded Yarn to v4, so it's probably better to check that those features are working well with Bun. Here are the features I think about:

• generatePackageJson option from webpack, remix, and other executors
• generateLockfile option from js tsc, swc, and other executors

Regarding the lockfile, Bun has the capability to produce a lockfile in the Yarn format, a format already compatible with Nx. See the related docs.

Ohh okay I see what you what is supposed to be supported. I can add that.
I'll copy Yarn's and make it Bun format.

[Jordan-Hall]

Hi, I just wanted to bring up that we should be careful with Nx features relying on the package manager, I remember facing issues with those when we upgraded Yarn to v4, so it's probably better to check that those features are working well with Bun. Here are the features I think about:

• generatePackageJson option from webpack, remix, and other executors
• generateLockfile option from js tsc, swc, and other executors

Regarding the lockfile, Bun has the capability to produce a lockfile in the Yarn format, a format already compatible with Nx. See the related docs.

Ohh okay I see what you what is supposed to be supported. I can add that. I'll copy Yarn's and make it Bun format.

You can take a look at this PR it had the bun lock all sorted #19113 should be able to drop in to this PR without issue

[guzmanoj]

Damn, we are soooo close. Also, Bun for Windows will be released in a couple of days!

[0xRapid]

Bun is out! Lets go :)

[laynef]

Closing this. You guys figure it out

[github-actions]

This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request.