Merge pull request #37 from 0xsequence/pnpm

Replace yarn with pnpm

Author: ScreamingHawk

.github/workflows/ci.yaml

@@ -1,4 +1,3 @@
-
 on: [push]
 
 name: ci
@@ -14,15 +13,19 @@ jobs:
       - uses: actions/setup-node@v1
         with:
           node-version: 18
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 10
       - uses: actions/cache@master
-        id: yarn-cache
+        id: pnpm-cache
         with:
           path: |
             node_modules
             */*/node_modules
-          key: ${{ runner.os }}-lerna-${{ hashFiles('**/package.json', '**/yarn.lock') }}
-      - run: yarn install --network-concurrency 1
-        if: ${{ steps.yarn-cache.outputs.cache-hit != 'true' }}
+            .pnpm-store
+          key: ${{ runner.os }}-pnpm-${{ hashFiles('**/package.json', '**/pnpm-lock.yaml') }}
+      - run: pnpm install --frozen-lockfile
+        if: ${{ steps.pnpm-cache.outputs.cache-hit != 'true' }}
 
   lint-sol:
     name: Solidity lint
@@ -35,21 +38,25 @@ jobs:
       - uses: actions/setup-node@v1
         with:
           node-version: 18
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 10
       - uses: actions/cache@master
-        id: yarn-cache
+        id: pnpm-cache
         with:
           path: |
             node_modules
             */*/node_modules
-          key: ${{ runner.os }}-lerna-${{ hashFiles('**/package.json', '**/yarn.lock') }}
+            .pnpm-store
+          key: ${{ runner.os }}-pnpm-${{ hashFiles('**/package.json', '**/pnpm-lock.yaml') }}
 
       - name: Install Foundry
         uses: foundry-rs/foundry-toolchain@v1
         with:
           version: nightly
 
       - name: Run linting
-        run: yarn lint:sol
+        run: pnpm lint:sol
 
   foundry-tests:
     name: Foundry tests
@@ -62,13 +69,17 @@ jobs:
       - uses: actions/setup-node@v1
         with:
           node-version: 18
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 10
       - uses: actions/cache@master
-        id: yarn-cache
+        id: pnpm-cache
         with:
           path: |
             node_modules
             */*/node_modules
-          key: ${{ runner.os }}-lerna-${{ hashFiles('**/package.json', '**/yarn.lock') }}
+            .pnpm-store
+          key: ${{ runner.os }}-pnpm-${{ hashFiles('**/package.json', '**/pnpm-lock.yaml') }}
 
       - name: Install Foundry
         uses: foundry-rs/foundry-toolchain@v1
@@ -89,14 +100,18 @@ jobs:
   #     - uses: actions/setup-node@v1
   #       with:
   #         node-version: 18
+  #     - uses: pnpm/action-setup@v2
+  #       with:
+  #         version: 10
   #     - uses: actions/cache@master
-  #       id: yarn-cache
+  #       id: pnpm-cache
   #       with:
   #         path: |
   #           node_modules
   #           */*/node_modules
-  #         key: ${{ runner.os }}-lerna-${{ hashFiles('**/package.json', '**/yarn.lock') }}
-  #     - run: yarn coverage || true
+  #           .pnpm-store
+  #         key: ${{ runner.os }}-pnpm-${{ hashFiles('**/package.json', '**/pnpm-lock.yaml') }}
+  #     - run: pnpm coverage || true
   #     - name: Coveralls
   #       uses: coverallsapp/github-action@master
   #       with:

.gitignore

@@ -7,9 +7,9 @@ report/
 # Ignore .DS_Store files on macOS
 .DS_Store
 
-# Yarn
+# PNPM
 node_modules/
-yarn-error.log
+pnpm-error.log
 
 # Env vars
 .env

README.md

@@ -20,17 +20,17 @@ Base and preset **implementations of common token standards**:
 
 Clone the repository, including git submodules.
 
-Install dependencies with `yarn`.
+Install dependencies with `pnpm i`.
 
-Compile the contracts with `yarn build`.
+Compile the contracts with `pnpm build`.
 
 ### Testing
 
-Run tests with `yarn test`.
+Run tests with `pnpm test`.
 
-Run coverage report with `yarn coverage`. View coverage report with `genhtml -o report --branch-coverage --ignore-errors category lcov.info && py -m http.server`. Viewing the report with this command requires Python to be installed.
+Run coverage report with `pnpm run coverage`. View coverage report with `genhtml -o report --branch-coverage --ignore-errors category lcov.info && py -m http.server`. Viewing the report with this command requires Python to be installed.
 
-Compare gas usage with `yarn snapshot:compare`. Note as some test use random values, the gas usage may vary slightly between runs.
+Compare gas usage with `pnpm run snapshot:compare`. Note as some test use random values, the gas usage may vary slightly between runs.
 
 ### Deployment
 
@@ -43,7 +43,7 @@ cp .env.example .env
 Then run the deployment script.
 
 ```sh
-yarn deploy --rpc-url $RPC_URL --broadcast
+pnpm deploy --rpc-url $RPC_URL --broadcast
 ```
 
 ## Dependencies

lefthook.yml

@@ -2,4 +2,4 @@ pre-commit:
   commands:
     lint-and-format:
       glob: '**/*.sol'
-      run: yarn format:sol {staged_files} && yarn lint:sol {staged_files} && git add {staged_files}
+      run: pnpm run format:sol {staged_files} && pnpm run lint:sol {staged_files} && git add {staged_files}