Use bun

Author: igoroctaviano

.github/workflows/deploy-to-firebase.yml

@@ -15,19 +15,16 @@ jobs:
       - name: Checkout to repository
         uses: actions/[email protected]
 
-      - name: Setup Node
-        uses: actions/setup-[email protected]
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v2
         with:
-          node-version: 20.8.1
-
-      - name: Install Yarn
-        run: sudo npm i -g yarn
+          bun-version: latest
 
       - name: Install dependencies
-        run: yarn
+        run: bun install --frozen-lockfile
 
       - name: Build
-        run: REACT_APP_CONFIG=preview PUBLIC_URL=/ yarn build
+        run: REACT_APP_CONFIG=preview PUBLIC_URL=/ bun run build
 
       - name: Deploy
         uses: FirebaseExtended/action-hosting-deploy@v0

.github/workflows/deploy-to-github-pages.yml

@@ -14,20 +14,17 @@ jobs:
       - name: Checkout to repository
         uses: actions/[email protected]
 
-      - name: Setup Node
-        uses: actions/setup-[email protected]
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v2
         with:
-          node-version: 20.8.1
-
-      - name: Install Yarn
-        run: sudo npm i -g yarn
+          bun-version: latest
 
       - name: Install dependencies
-        run: yarn
+        run: bun install --frozen-lockfile
 
       - name: Build and deploy to GitHub Pages
         run: |
           git remote set-url origin https://git:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git
-          yarn deploy -- -u "github-actions-bot <[email protected]>"
+          bun run deploy -- -u "github-actions-bot <[email protected]>"
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release.yml

@@ -16,16 +16,16 @@ jobs:
           ref: master
           persist-credentials: false
 
-      - name: Setup Node
-        uses: actions/setup-[email protected]
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v2
         with:
-          node-version: 20.8.1
+          bun-version: latest
 
       - name: Install dependencies
-        run: yarn
+        run: bun install --frozen-lockfile
 
       - name: Build
-        run: yarn build
+        run: bun run build
 
       - name: Zip build
         run: zip -r build.zip build
@@ -37,4 +37,4 @@ jobs:
           GIT_AUTHOR_EMAIL: ${{ vars.RELEASE_GIT_AUTHOR_EMAIL }}
           GIT_COMMITTER_NAME: ${{ vars.RELEASE_GIT_COMMITTER_NAME }}
           GIT_COMMITTER_EMAIL: ${{ vars.RELEASE_GIT_COMMITTER_EMAIL }}
-        run: npx semantic-release --branches master
+        run: bunx semantic-release --branches master

.github/workflows/unit-tests.yml

@@ -14,19 +14,19 @@ jobs:
       - name: Checkout to repository
         uses: actions/[email protected]
 
-      - name: Setup Node
-        uses: actions/setup-[email protected]
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v2
         with:
-          node-version: 20.8.1
+          bun-version: latest
 
       - name: Install dependencies
-        run: yarn
+        run: bun install --frozen-lockfile
 
       - name: Build
-        run: yarn build
+        run: bun run build
 
       - name: Lint
-        run: yarn lint
+        run: bun run lint
 
       - name: Test
-        run: yarn test
+        run: bun run test

CONTRIBUTING.md

@@ -31,15 +31,15 @@ The app is built using [craco](https://github.com/gsoft-inc/craco) (with the [cr
 
 Tests are written and run using the [jest](https://jestjs.io/) framework.
 
-The [yarn](https://yarnpkg.com/) package manager is used to manage dependencies and run scripts specified in `package.json` (`build`, `lint`, `test`, etc.).
+The [Bun](https://bun.sh/) runtime and package manager is used to manage dependencies and run scripts specified in `package.json` (`build`, `lint`, `test`, etc.).
 
 ## Coding style
 
 Source code is linted using [ts-standard](https://github.com/standard/ts-standard) (based on [eslint](https://eslint.org/)) and TypeScript is used with [strict type checking compiler options](https://www.typescriptlang.org/tsconfig#Strict_Type_Checking_Options_6173) enabled.
 
 Use the following command to identify potential coding style and type annotation violations:
 
-    $ yarn lint
+    $ bun run lint
 
 
 ### Documentation

README.md

@@ -236,8 +236,8 @@ When enabled, the memory footer appears at the bottom of all pages and monitors
 Download the latest release from [github.com/imagingdatacommons/slim/releases](https://github.com/imagingdatacommons/slim/releases) and then run the following commands to install build dependencies and build the app:
 
 ```none
-yarn install
-PUBLIC_URL=/ yarn build
+bun install
+PUBLIC_URL=/ bun run build
 ```
 
 Once the app has been built, the content of the `build` folder can be directly served by a static web server at the location specified by `PUBLIC_URL` (in this case at `/`).
@@ -374,57 +374,57 @@ For the time being, the legacy implicit grand type has to be used.
 To install requirements and run the app for local development, run the following commands:
 
 ```none
-yarn install
-yarn start
+bun install
+bun run start
 ```
 
 This will serve the app via a development server at [http://localhost:3000](http://localhost:3000) using the default `local` configuration.
 
 The configuration can be specified using the `REACT_APP_CONFIG` environment variable, which can be set either in the `.env` file or directly in the command line:
 
 ```none
-REACT_APP_CONFIG=local yarn start
+REACT_APP_CONFIG=local bun run start
 ```
 
 ## Linking Slim to a Local dicom-microscopy-viewer Library
 
-If you are developing features or fixing bugs that require changes in both Slim and the underlying [`dicom-microscopy-viewer`](https://github.com/ImagingDataCommons/dicom-microscopy-viewer) library, you can use `yarn link` to connect your local Slim project to a local clone of `dicom-microscopy-viewer`. This allows Slim to immediately use the latest local changes from the library without publishing to npm.
+If you are developing features or fixing bugs that require changes in both Slim and the underlying [`dicom-microscopy-viewer`](https://github.com/ImagingDataCommons/dicom-microscopy-viewer) library, you can use `bun link` to connect your local Slim project to a local clone of `dicom-microscopy-viewer`. This allows Slim to immediately use the latest local changes from the library without publishing to npm.
 
 ### Steps
 
 1. **Clone dicom-microscopy-viewer**  
    If you haven't already, clone the `dicom-microscopy-viewer` repository to your machine.
 
-2. **Set up yarn link in dicom-microscopy-viewer**  
+2. **Set up bun link in dicom-microscopy-viewer**  
    In the root directory of your local `dicom-microscopy-viewer` repository, run:
    ```sh
-   yarn link
+   bun link
    ```
 
 3. **Link dicom-microscopy-viewer in Slim**  
    In the root directory of your Slim project, run:
    ```sh
-   yarn link dicom-microscopy-viewer
+   bun link dicom-microscopy-viewer
    ```
 
 4. **Enable live rebuilding in dicom-microscopy-viewer**  
    To automatically rebuild `dicom-microscopy-viewer` when you make changes, run the following command in the `dicom-microscopy-viewer` directory:
    ```sh
-   yarn webpack:dynamic-import:watch
+   bun run webpack:dynamic-import:watch
    ```
    This will watch for file changes and rebuild the library, so Slim can immediately use the updated code.
 
 5. **Run Slim as usual**  
    In the Slim directory, start the development server:
    ```sh
-   yarn start
+   bun run start
    ```
    Slim will now use your locally linked version of `dicom-microscopy-viewer`.
 
 ### Notes
 
-- If you want to unlink and return to the npm-published version, run `yarn unlink dicom-microscopy-viewer` and `yarn install --force` in the Slim directory.
-- Make sure both projects use compatible Node and Yarn versions to avoid dependency issues.
+- If you want to unlink and return to the npm-published version, run `bun unlink dicom-microscopy-viewer` and `bun install` in the Slim directory.
+- Make sure both projects use compatible Bun versions to avoid dependency issues.
 
 ## Citation