Merge pull request #218 from PaulRBerg/build/bun

build: switch to bun for dep management

.github/workflows/ci.yml

@@ -21,22 +21,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: |
@@ -49,19 +41,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: "Install Foundry"
         uses: "foundry-rs/foundry-toolchain@v1"
@@ -84,19 +68,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"
         run: "forge test"

.gitignore

@@ -8,5 +8,6 @@ out
 *.log
 .DS_Store
 .pnp.*
-pnpm-
+package-lock.json
+pnpm-lock.yaml
 yarn.lock

.prettierignore

@@ -8,6 +8,7 @@ out
 *.log
 .DS_Store
 .pnp.*
+bun.lockb
 package-lock.json
 pnpm-lock.yaml
 yarn.lock

README.md

@@ -32,10 +32,10 @@ all the boxes mentioned thus far, but it doesn't offer type safety.
 All users are recommended to install PRBMath as a Node.js package:
 
 ```sh
-pnpm add @prb/math
+bun add @prb/math
 ```
 
-This example uses Pnpm, but using Yarn or Npm is also possible.
+This example uses Bun, but it also possible to use Npm, Yarn, or Pnpm.
 
 ### Foundry
 
@@ -336,7 +336,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.
 
@@ -351,7 +351,7 @@ $ git clone --recurse-submodules -j8 [email protected]:PaulRBerg/prb-math.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,8 +40,8 @@
   "scripts": {
     "build": "forge build",
     "clean": "rm -rf cache out",
-    "lint": "pnpm lint:sol && pnpm prettier:check",
-    "lint:sol": "forge fmt --check && pnpm solhint \"{src,test}/**/*.sol\"",
+    "lint": "bun run lint:sol && bun run prettier:check",
+    "lint:sol": "forge fmt --check && bun solhint \"{src,test}/**/*.sol\"",
     "prettier:check": "prettier --check \"**/*.{json,md,yml}\"",
     "prettier:write": "prettier --write \"**/*.{json,md,yml}\""
   }