feat: bun (#55)

Author: jxom

.github/CONTRIBUTING.md

@@ -96,7 +96,7 @@ messenger.reply('ping', (args) => {
 This guide is intended to help you get started with contributing. By following these steps, you will understand the development process and workflow.
 
 1. [Cloning the repository](#cloning-the-repository)
-2. [Installing Node.js and pnpm](#installing-nodejs-and-pnpm)
+2. [Installing Bun](#installing-bun)
 3. [Installing Anvil](#installing-anvil)
 4. [Installing dependencies](#installing-dependencies)
 5. [Running the Web Extension](#running-the-web-extension)
@@ -123,21 +123,19 @@ gh repo clone paradigmxyz/rivet
   <a href="#getting-started">&uarr; back to top</a></b>
 </div>
 
-### Installing Node.js and pnpm
+### Installing Bun
 
-Rivet uses [pnpm](https://pnpm.io/workspaces). You need to install **Node.js v18 or higher** and **pnpm v8 or higher**.
+wagmi uses [Bun](https://bun.sh). You need to install **Bun v1 or higher**.
 
-You can run the following commands in your terminal to check your local Node.js and pnpm versions:
+You can run the following commands in your terminal to check your local Bun version:
 
 ```bash
-node -v
-pnpm -v
+bun -v
 ```
 
-If the versions are not correct or you don't have Node.js or pnpm installed, download and follow their setup instructions:
+If the versions are not correct or you don't have Bun installed, download and follow their setup instructions:
 
-- Install Node.js using [fnm](https://github.com/Schniz/fnm) or from the [official website](https://nodejs.org)
-- Install [pnpm](https://pnpm.io/installation)
+- Install [Bun](https://bun.sh/docs/install)
 
 <div align="right">
   <a href="#getting-started">&uarr; back to top</a></b>
@@ -162,7 +160,7 @@ curl -L https://foundry.paradigm.xyz | bash
 Once in the project's root directory, run the following command to install the project's dependencies:
 
 ```bash
-pnpm install
+bun i
 ```
 
 <div align="right">
@@ -174,7 +172,7 @@ pnpm install
 After you have installed dependencies, you are ready to run the Web Extension. To do so, run the following:
 
 ```bash
-pnpm dev # start dev server
+bun run dev # start dev server
 ```
 
 This will run a script that will build the Web Extension and start a dev server for the Test Dapp, it will also open the Test Dapp in a new browser tab. The Web Extension also utilizes Hot Module Replacement (HMR), so you can make changes to the code and see them reflected in the extension without having to reload the extension itself.

.github/actions/install-dependencies/action.yml

@@ -4,18 +4,12 @@ description: "Prepare repository and all dependencies"
 runs:
   using: "composite"
   steps:
-    - name: Set up pnpm
-      uses: pnpm/action-setup@v2
-
-    - name: Set up node
-      uses: actions/setup-node@v3
-      with:
-        cache: pnpm
-        node-version: 18
+    - name: Set up Bun
+      uses: oven-sh/setup-bun@v1
 
     - name: Set up foundry
       uses: foundry-rs/foundry-toolchain@v1
 
     - name: Install dependencies
       shell: bash
-      run: pnpm install --ignore-scripts
+      run: bun install --yarn --ignore-scripts

.github/workflows/artifacts.yml

@@ -16,7 +16,7 @@ jobs:
         uses: ./.github/actions/install-dependencies
 
       - name: Build
-        run: pnpm build
+        run: bun run build
 
       - name: Upload Artifact
         uses: actions/upload-artifact@v3

.github/workflows/verify.yml

@@ -17,7 +17,7 @@ jobs:
         uses: ./.github/actions/install-dependencies
 
       - name: Lint code
-        run: pnpm format && pnpm lint:fix
+        run: bun run format && bun run lint:fix
 
       - uses: stefanzweifel/git-auto-commit-action@v4
         env:
@@ -41,7 +41,7 @@ jobs:
         uses: ./.github/actions/install-dependencies
 
       - name: Build
-        run: pnpm build
+        run: bun run build
 
   types:
     name: Types
@@ -57,4 +57,4 @@ jobs:
         uses: ./.github/actions/install-dependencies
 
       - name: Check types
-        run: pnpm typecheck
+        run: bun run typecheck

README.md

@@ -79,36 +79,34 @@ Clone the repo to your local machine using git:
 git clone https://github.com/paradigmxyz/rivet.git
 ```
 
-### 2. Install Node.js and pnpm
+### 2. Install Bun
 
-You need to install **Node.js v18 or higher** and **pnpm v8 or higher**.
+wagmi uses [Bun](https://bun.sh). You need to install **Bun v1 or higher**.
 
-You can run the following commands in your terminal to check your local Node.js and pnpm versions:
+You can run the following commands in your terminal to check your local Bun version:
 
 ```bash
-node -v
-pnpm -v
+bun -v
 ```
 
-If the versions are not correct or you don't have Node.js or pnpm installed, download and follow their setup instructions:
+If the versions are not correct or you don't have Bun installed, download and follow their setup instructions:
 
-- Install Node.js using [fnm](https://github.com/Schniz/fnm) or from the [official website](https://nodejs.org)
-- Install [pnpm](https://pnpm.io/installation)
+- Install [Bun](https://bun.sh/docs/install)
 
 ### 3. Install dependencies
 
 Once in the project's root directory, run the following command to install the project's dependencies:
 
 ```bash
-pnpm install
+bun i
 ```
 
 ### 4. Run the dev server
 
 After you have installed dependencies, you are ready to run the dev server for the Extension. To do so, run the following:
 
 ```bash
-pnpm dev 
+bun run dev 
 ```
 
 This will run a script that will build the Web Extension and start a dev server for the Test Dapp, it will also open the Test Dapp in a new browser tab.

biome.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://biomejs.dev/schemas/1.0.0/schema.json",
   "files": {
-    "ignore": ["node_modules", "public", "dist"]
+    "ignore": ["node_modules", "public", "dist", "symbols/generated"]
   },
   "formatter": {
     "enabled": true,

bun.lockb

@@ -0,0 +1,2 @@
+/// <reference lib="dom" />
+/// <reference lib="dom.iterable" />

dom.d.ts

@@ -7,20 +7,21 @@
   },
   "scripts": {
     "anvil": "anvil --fork-url https://cloudflare-eth.com",
-    "build": "tsc && vite build && pnpm build:inpage",
+    "build": "tsc && vite build && bun run build:inpage",
     "build:ds": "vite build -c src/design-system/vite.config.ts",
     "build:inpage": "vite build -c vite.config.inpage.ts",
     "clean": "rimraf dist",
-    "dev": "cross-env NODE_ENV=development pnpm build:inpage && vite --open",
+    "dev": "cross-env NODE_ENV=development bun run build:inpage && vite --open",
     "format": "biome format . --write",
     "lint": "biome check .",
-    "lint:fix": "pnpm lint --apply",
-    "prepare": "pnpm build:ds",
-    "symbols": "node -r esbuild-register scripts/generate-symbols.ts",
+    "lint:fix": "bun run lint --apply",
+    "preinstall": "bun scripts/preinstall.ts",
+    "postinstall": "patch-package",
+    "prepare": "bun run build:ds",
+    "symbols": "bun scripts/symbols.ts",
     "typecheck": "tsc --noEmit"
   },
-  "devDependencies": {
-    "@biomejs/biome": "1.0.0",
+  "dependencies": {
     "@capsizecss/core": "^3.1.0",
     "@capsizecss/vanilla-extract": "^1.0.0",
     "@fastify/deepmerge": "^1.3.0",
@@ -32,41 +33,19 @@
     "@radix-ui/react-progress": "^1.0.3",
     "@radix-ui/react-tabs": "^1.0.4",
     "@radix-ui/react-tooltip": "^1.0.6",
-    "@samrum/vite-plugin-web-extension": "^4.1.0",
     "@tanstack/query-async-storage-persister": "5.0.0-alpha.42",
     "@tanstack/react-query": "5.0.0-alpha.42",
     "@tanstack/react-query-persist-client": "5.0.0-alpha.42",
     "@tanstack/react-virtual": "3.0.0-beta.54",
-    "@types/chroma-js": "^2.4.0",
-    "@types/chrome": "^0.0.244",
-    "@types/d3-format": "^3.0.1",
-    "@types/fs-extra": "^11.0.1",
-    "@types/node": "^18.15.11",
-    "@types/opentype.js": "^1.3.4",
-    "@types/prettier": "^2.7.2",
-    "@types/qs": "^6.9.7",
-    "@types/react": "^18.0.32",
-    "@types/react-dom": "^18.0.11",
-    "@types/use-sync-external-store": "^0.0.3",
-    "@types/webextension-polyfill": "^0.10.0",
     "@vanilla-extract/css": "^1.11.0",
     "@vanilla-extract/css-utils": "^0.1.3",
     "@vanilla-extract/dynamic": "^2.0.3",
     "@vanilla-extract/sprinkles": "^1.6.0",
-    "@vanilla-extract/vite-plugin": "^3.8.0",
-    "@vitejs/plugin-react": "^4.0.0-beta.0",
     "chroma-js": "^2.4.2",
     "clsx": "^1.2.1",
-    "cross-env": "^7.0.3",
-    "d3-format": "^3.1.0",
-    "esbuild": "^0.17.17",
-    "esbuild-register": "^3.4.2",
     "eventemitter3": "^5.0.1",
-    "fs-extra": "^11.1.1",
     "human-id": "^4.0.0",
     "mipd": "^0.0.5",
-    "opentype.js": "^1.3.4",
-    "prettier": "^2.8.7",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "react-flatten-children": "^1.1.2",
@@ -75,26 +54,40 @@
     "react-router": "^6.10.0",
     "react-router-dom": "^6.10.0",
     "remeda": "^1.14.0",
+    "use-sync-external-store": "^1.2.0",
+    "viem": "^1.10.12",
+    "zustand": "^4.3.8"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "1.0.0",
+    "@samrum/vite-plugin-web-extension": "^4.1.0",
+    "@types/chroma-js": "^2.4.0",
+    "@types/chrome": "^0.0.244",
+    "@types/opentype.js": "^1.3.4",
+    "@types/qs": "^6.9.7",
+    "@types/react": "^18.0.32",
+    "@types/react-dom": "^18.0.11",
+    "@types/use-sync-external-store": "^0.0.3",
+    "@types/webextension-polyfill": "^0.10.0",
+    "@types/which-pm-runs": "^1.0.0",
+    "@vanilla-extract/vite-plugin": "^3.8.0",
+    "@vitejs/plugin-react": "^4.0.0-beta.0",
+    "bun-types": "^1.0.1",
+    "cross-env": "^7.0.3",
+    "opentype.js": "^1.3.4",
+    "patch-package": "^8.0.0",
     "rimraf": "^5.0.1",
     "simple-git-hooks": "^2.8.1",
     "svg-path-commander": "^2.0.5",
     "typescript": "^5.0.4",
-    "use-sync-external-store": "^1.2.0",
-    "viem": "^1.9.2",
     "vite": "^4.3.0",
     "vite-plugin-crx-hot-reload": "^1.0.4",
     "vite-tsconfig-paths": "^4.2.0",
     "web-ext": "^7.6.1",
     "webextension-polyfill": "^0.10.0",
-    "zustand": "^4.3.8"
+    "which-pm-runs": "^1.1.0"
   },
   "simple-git-hooks": {
-    "pre-commit": "pnpm format && pnpm lint:fix"
-  },
-  "packageManager": "[email protected]",
-  "pnpm": {
-    "patchedDependencies": {
-      "@samrum/[email protected]": "patches/@[email protected]"
-    }
+    "pre-commit": "bun run format && bun run lint:fix"
   }
 }

package.json

@@ -0,0 +1,26 @@
+diff --git a/node_modules/@samrum/vite-plugin-web-extension/dist/index.es.js b/node_modules/@samrum/vite-plugin-web-extension/dist/index.es.js
+index f2d642d..56beb35 100644
+--- a/node_modules/@samrum/vite-plugin-web-extension/dist/index.es.js
++++ b/node_modules/@samrum/vite-plugin-web-extension/dist/index.es.js
+@@ -186,7 +186,7 @@ class DevBuilder {
+     }
+     async writeBuild({ devServerPort, manifestHtmlFiles, }) {
+         this.hmrServerOrigin = this.getHmrServerOrigin(devServerPort);
+-        await emptyDir(this.outDir);
++        // await emptyDir(this.outDir);
+         const publicDir = path.resolve(process.cwd(), this.viteConfig.root, this.viteConfig.publicDir);
+         copy(publicDir, this.outDir);
+         await this.writeManifestHtmlFiles(manifestHtmlFiles);
+diff --git a/node_modules/@samrum/vite-plugin-web-extension/dist/index.js b/node_modules/@samrum/vite-plugin-web-extension/dist/index.js
+index a16b52f..65627cb 100644
+--- a/node_modules/@samrum/vite-plugin-web-extension/dist/index.js
++++ b/node_modules/@samrum/vite-plugin-web-extension/dist/index.js
+@@ -188,7 +188,7 @@ class DevBuilder {
+     }
+     async writeBuild({ devServerPort, manifestHtmlFiles, }) {
+         this.hmrServerOrigin = this.getHmrServerOrigin(devServerPort);
+-        await fsExtra.emptyDir(this.outDir);
++        // await fsExtra.emptyDir(this.outDir);
+         const publicDir = path.resolve(process.cwd(), this.viteConfig.root, this.viteConfig.publicDir);
+         fsExtra.copy(publicDir, this.outDir);
+         await this.writeManifestHtmlFiles(manifestHtmlFiles);