Build: Introducing Bun for Script Execution

[valentinpalkovic]

Closes N/A

What I did

This PR introduces a significant change to our script execution process. We are now using Bun, a powerful tool for running scripts from the scripts directory. Bun provides a simple and efficient way to manage and run our scripts, improving our development workflow.

To start using Bun locally, you will need to install it. You can do this by running the following command in your terminal:

curl -fsSL https://bun.sh/install | bash

Once Bun is installed, you can run for example the yarn task command as usual.

In addition to introducing Bun, this PR also includes an update to our execa configuration. I've updated execa to the latest version and made some changes to its configuration. Please note that Bun currently does not support inheriting stdio from the main process, so we've configured execa to handle this aspect of our script execution process.

The most important work is split into the following chunks

• CI: Configure bun on CircleCI
• Docs: Edit contribution guide to setup bun
• Build: Use bun to run scripts instead of esbuild-register
• Build: Modify scripts to make them compatible for Bun runtime - That's the most interesting chunk for review
• Build: Streamline yarn version

Motivation

Previously, we used esbuild-register for on-the-fly transformation of ECMAScript modules (ESM) to CommonJS (CJS). However, we encountered a significant bug in esbuild-register when using it with newer Node.js versions (20.6.0 and above). This bug has been open for a while and doesn't seem to be getting fixed in the near future.

Moreover, the use of esbuild-register was somewhat counterproductive to our long-term goal. We plan to phase out the use of CommonJS in favor of ECMAScript modules. The on-the-fly transformation of ESM to CJS by esbuild-register was a step away from this goal.

By switching to Bun, we are not only circumventing the bug in esbuild-register, but also taking a step closer to our goal of fully adopting ECMAScript modules. Bun's built-in TypeScript support allows us to write our scripts directly in TypeScript and run them as ECMAScript modules, eliminating the need for on-the-fly transformations to CommonJS.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

• stories
• unit tests
• integration tests
• end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

• Add or update documentation reflecting your changes
• If you are deprecating/removing a feature, make sure to update
  MIGRATION.MD

Checklist for Maintainers

• When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

• Make sure this PR contains one of the labels below:

  Available labels

  • bug: Internal changes that fixes incorrect behavior.
  • maintenance: User-facing maintenance tasks.
  • dependencies: Upgrading (sometimes downgrading) dependencies.
  • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
  • cleanup: Minor cleanup style change. Will not show up in release changelog.
  • documentation: Documentation only changes. Will not show up in release changelog.
  • feature request: Introducing a new feature.
  • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
  • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 84d2574. 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 2 targets

• nx affected -t check -c production --parallel=7
• nx run-many -t build -c production --parallel=3

---

Sent with 💌 from NxCloud.