build: switch to bun for dep management

Author: PaulRBerg

.github/workflows/ci.yml

@@ -21,22 +21,19 @@ jobs:
       - name: "Install Foundry"
         uses: "foundry-rs/foundry-toolchain@v1"
 
-      - name: "Install Pnpm"
-        uses: "pnpm/action-setup@v2"
-        with:
-          version: "8"
-
       - name: "Install Node.js"
         uses: "actions/setup-node@v3"
         with:
-          cache: "pnpm"
           node-version: "lts/*"
 
+      - name: "Install Bun"
+        uses: "oven-sh/setup-bun@v1"
+
       - name: "Install the Node.js dependencies"
-        run: "pnpm install"
+        run: "bun install"
 
-      - name: "Lint the contracts"
-        run: "pnpm lint"
+      - name: "Lint the code"
+        run: "bun run lint"
 
       - name: "Add lint summary"
         run: |
@@ -52,19 +49,16 @@ jobs:
       - name: "Install Foundry"
         uses: "foundry-rs/foundry-toolchain@v1"
 
-      - name: "Install Pnpm"
-        uses: "pnpm/action-setup@v2"
-        with:
-          version: "8"
-
       - name: "Install Node.js"
         uses: "actions/setup-node@v3"
         with:
-          cache: "pnpm"
           node-version: "lts/*"
 
+      - name: "Install Bun"
+        uses: "oven-sh/setup-bun@v1"
+
       - name: "Install the Node.js dependencies"
-        run: "pnpm install"
+        run: "bun install"
 
       - name: "Build the contracts and print their size"
         run: "forge build --sizes"
@@ -84,19 +78,16 @@ jobs:
       - name: "Install Foundry"
         uses: "foundry-rs/foundry-toolchain@v1"
 
-      - name: "Install Pnpm"
-        uses: "pnpm/action-setup@v2"
-        with:
-          version: "8"
-
       - name: "Install Node.js"
         uses: "actions/setup-node@v3"
         with:
-          cache: "pnpm"
           node-version: "lts/*"
 
+      - name: "Install Bun"
+        uses: "oven-sh/setup-bun@v1"
+
       - name: "Install the Node.js dependencies"
-        run: "pnpm install"
+        run: "bun install"
 
       - name: "Show the Foundry config"
         run: "forge config"

.gitignore

@@ -10,6 +10,8 @@ out
 .DS_Store
 .pnp.*
 lcov.info
+package-lock.json
+pnpm-lock.yaml
 yarn.lock
 
 # broadcasts

.prettierignore

@@ -10,6 +10,7 @@ out
 *.log
 .DS_Store
 .pnp.*
+bun.lockb
 lcov.info
 package-lock.json
 pnpm-lock.yaml

README.md

@@ -31,7 +31,7 @@ Or, if you prefer to install the template manually:
 $ mkdir my-project
 $ cd my-project
 $ forge init --template PaulRBerg/foundry-template
-$ pnpm install # install Solhint, Prettier, and other Node.js deps
+$ bun install # install Solhint, Prettier, and other Node.js deps
 ```
 
 If this is your first time with Foundry, check out the
@@ -83,8 +83,8 @@ Foundry typically uses git submodules to manage dependencies, but this template
 
 This is how to install dependencies:
 
-1. Install the dependency using your preferred package manager, e.g. `pnpm add dependency-name`
-   - Use this syntax to install from GitHub: `pnpm add github:username/repo-name`
+1. Install the dependency using your preferred package manager, e.g. `bun install dependency-name`
+   - Use this syntax to install from GitHub: `bun install github:username/repo-name`
 2. Add a remapping for the dependency in [remappings.txt](./remappings.txt), e.g.
    `dependency-name=node_modules/dependency-name`
 
@@ -170,7 +170,7 @@ $ forge test --gas-report
 Lint the contracts:
 
 ```sh
-$ pnpm lint
+$ bun run lint
 ```
 
 ### Test
@@ -184,14 +184,14 @@ $ forge test
 Generate test coverage and output result to the terminal:
 
 ```sh
-$ pnpm test:coverage
+$ bun run test:coverage
 ```
 
 Generate test coverage with lcov report (you'll have to open the `./coverage/index.html` file in your browser, to do so
 simply copy paste the path):
 
 ```sh
-$ pnpm test:coverage:report
+$ bun run test:coverage:report
 ```
 
 ## Related Efforts

bun.lockb

@@ -28,8 +28,8 @@
   "scripts": {
     "clean": "rm -rf cache out",
     "build": "forge build",
-    "lint": "pnpm lint:sol && pnpm prettier:check",
-    "lint:sol": "forge fmt --check && pnpm solhint {script,src,test}/**/*.sol",
+    "lint": "bun run lint:sol && bun run prettier:check",
+    "lint:sol": "forge fmt --check && bun run solhint {script,src,test}/**/*.sol",
     "prettier:check": "prettier --check **/*.{json,md,yml} --ignore-path=.prettierignore",
     "prettier:write": "prettier --write **/*.{json,md,yml} --ignore-path=.prettierignore",
     "test": "forge test",