Chore/use bun as a package manager and script runner #2148
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
coolsoftwaretyler
changed the title
coolsoftwaretyler
deleted the
chore/use-bun-a-package-manager-and-script-runner
branch
coolsoftwaretyler
added a commit
that referenced
this pull request
Feb 26, 2024
* chore: use bun for package management * chore: update contributing docs to point to Bun * chore: try to use Bun in CircleCI rather than yarn * chore: use bun in pre-commit hook instead of yarn * chore: update package json scripts to bun * chore: prettier:write on some tests * chore: run publish-docs * fix: circle CI typos * fix: install bun in Circle CI test runners
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do and why?
This PR will supercede #2103 so we can more easily pull in the TypeScript upgrades from #2103.
It swaps us over to using Bun as a package manager and script runner for MobX-State-Tree development.
There should be no downstream effects of this change. All scripts from
package.jsonare compatible with Bun, but now our dependency downloads are much much faster than withyarn. This also opens the door to using the Bun test runner which is faster than Jest, and understands TypeScript by default.I updated the docs to point people to Bun for these commands, as opposed to Yarn. And I updated our CircleCI jobs to use Bun as well (probably needs some iteration - I will check during the CI stage of this PR).
Steps to validate locally
Pull this down, remove your
node_modulesfolder, and runbun install(assuming you already have Bun on your machine. Run any and all scrips frompackage.jsonand you'll see it all works withbun runas opposed toyarn. You can just go from top to bottom in thescriptsblock and verify things work as expected.While running these tests, I also: