Merge pull request #184 from PaulRBerg/build/bun

build: switch to bun for dep management

.github/workflows/ci-deep.yml

@@ -20,22 +20,14 @@ 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: |

.github/workflows/ci.yml

@@ -25,22 +25,14 @@ 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: |
@@ -56,19 +48,11 @@ 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"
@@ -112,19 +96,11 @@ jobs:
           key: "foundry-build-${{ github.sha }}"
           path: "out-optimized"
 
-      - 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: "Run the tests against the optimized build"
         run: "FOUNDRY_PROFILE=test-optimized forge test"
@@ -144,19 +120,11 @@ 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: "Run the tests and generate the coverage report"
         run: "forge coverage --report lcov"
@@ -178,19 +146,11 @@ jobs:
       - name: "Check out the repo"
         uses: "actions/checkout@v3"
 
-      - 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: "Run Slither"
         uses: "crytic/[email protected]"

.gitignore

@@ -13,4 +13,6 @@ out
 .DS_Store
 .pnp.*
 lcov.info
+package-lock.json
+pnpm-lock.yaml
 yarn.lock

.prettierignore

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

CONTRIBUTING.md

@@ -10,7 +10,7 @@ You will need the following software on your machine:
 - [Git](https://git-scm.com/downloads)
 - [Foundry](https://github.com/foundry-rs/foundry)
 - [Node.Js](https://nodejs.org/en/download/)
-- [Pnpm](https://pnpm.io)
+- [Bun](https://bun.sh)
 
 In addition, familiarity with [Solidity](https://soliditylang.org/) is requisite.
 
@@ -25,7 +25,7 @@ $ git clone --recurse-submodules -j8 [email protected]:PaulRBerg/prb-proxy.git
 Then, inside the project's directory, run this to install the Node.js dependencies:
 
 ```sh
-$ pnpm install
+$ bun install
 ```
 
 Now you can start making changes.

package.json

@@ -40,12 +40,12 @@
     "build": "forge build",
     "build:optimized": "FOUNDRY_PROFILE=optimized forge build",
     "clean": "rm -rf artifacts broadcast cache coverage docs out out-optimized",
-    "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 solhint \"{script,src,test}/**/*.sol\"",
     "gas:report": "forge test --gas-report --no-match-test \"test(Fuzz)?_RevertWhen_\"",
     "gas:snapshot": "forge snapshot --no-match-test \"test(Fuzz)?_RevertWhen_\"",
-    "prepack": "pnpm install && bash ./shell/prepare-artifacts.sh",
-    "gas:snapshot:optimized": "pnpm build:optimized && FOUNDRY_PROFILE=test-optimized forge snapshot --no-match-test \"test(Fuzz)?_RevertWhen_\"",
+    "prepack": "bun install && bash ./shell/prepare-artifacts.sh",
+    "gas:snapshot:optimized": "bun run build:optimized && FOUNDRY_PROFILE=test-optimized forge snapshot --no-match-test \"test(Fuzz)?_RevertWhen_\"",
     "prettier:check": "prettier --check \"**/*.{json,md,yml}\"",
     "prettier:write": "prettier --write \"**/*.{json,md,yml}\""
   }