Improve pnpm setup (#694)

krzkaczor · web-flow · commit b53dd7f745ba · 2022-05-16T12:01:37.000+02:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -17,13 +17,13 @@ jobs:
       - uses: actions/checkout@v1
       - uses: pnpm/action-setup@v2
         with:
-          version: 6
+          version: 7.1.0
       - uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node }}
           cache: 'pnpm'
 
-      - run: pnpm install --frozen-lockfile
+      - run: pnpm install
 
       - run: pnpm build
       - run: pnpm lint
@@ -35,20 +35,23 @@ jobs:
       fail-fast: false
       matrix:
         node: ['14.x']
-        os: [ubuntu-latest, windows-latest]
+        os: [
+          ubuntu-latest
+        # , windows-latest # disabled windows builds due to stability issues
+        ]
     runs-on: ${{ matrix.os }}
 
     steps:
       - uses: actions/checkout@v1
       - uses: pnpm/action-setup@v2
         with:
-          version: 6
+          version: 7.1.0
       - uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node }}
           cache: 'pnpm'
 
-      - run: pnpm install --frozen-lockfile
+      - run: pnpm install
 
       - run: pnpm build
       - run: pnpm test
@@ -60,8 +63,6 @@ jobs:
 
   test-examples:
     strategy:
-      # When set to true, GitHub cancels all in-progress jobs if any matrix job fails.
-      fail-fast: false
       matrix:
         node: ['14.x']
         os: [ubuntu-latest, windows-latest]
@@ -71,13 +72,15 @@ jobs:
       - uses: actions/checkout@v1
       - uses: pnpm/action-setup@v2
         with:
-          version: 6
+          version: 7.1.0
       - uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node }}
           cache: 'pnpm'
-      - run: pnpm --filter ./packages install --frozen-lockfile
-      - run: pnpm --filter ./examples install --frozen-lockfile
+      - run: pnpm install
+        # Second install is needed to link bin files that were created only after build (post install hook to first pnpm install)
+      - run: pnpm install
+
       - run: pnpm check-examples
       - run: pnpm no-git-changes # ensure that committed types are up to date
         if: runner.os == 'Linux'
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -17,13 +17,13 @@ jobs:
 
       - uses: pnpm/action-setup@v2
         with:
-          version: 6
+          version: 7.1.0
       - uses: actions/setup-node@v2
         with:
           node-version: '14.x'
           cache: 'pnpm'
 
-      - run: pnpm install --frozen-lockfile
+      - run: pnpm install
 
       - name: Create Release Pull Request or Publish to npm
         uses: changesets/action@master
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -4,6 +4,9 @@ We welcome all contributions!
 
 ## Developing
 
+Heads up: we use pnpm instead of yarn or npm. It might be new for you but I promise it's worth the hassle - it's really
+good at making big monorepos deterministic. Please ensure that you are running pnpm version 7.
+
 First, run `pnpm i` to install all deps.
 
 We use TypeScript monorepo, each target is a separate package and has another package with tests. You need to run
diff --git a/examples/hardhat-truffe-v5/package.json b/examples/hardhat-truffe-v5/package.json
@@ -36,7 +36,8 @@
     "web3-core-promievent": "^1.2.1",
     "web3-eth-abi": "^1.2.1",
     "web3-utils": "^1.2.1",
-    "bn.js": "^4.11.0"
+    "bn.js": "^4.11.0",
+    "@types/bn.js": "^4.11.6"
   },
   "dependencies": {}
 }
diff --git a/package.json b/package.json
@@ -3,20 +3,21 @@
   "private": true,
   "license": "MIT",
   "engines": {
-    "pnpm": ">=6.14.0"
+    "node": ">=14.0.0",
+    "pnpm": ">=7.0.0"
   },
   "scripts": {
     "postinstall": "pnpm build",
     "format": "prettier --check \"./**/*.ts\" README.md",
     "format:fix": "prettier --write \"./**/*.ts\" README.md",
-    "lint": "pnpm run --parallel --aggregate-output --reporter append-only --filter ./packages lint",
-    "lint:fix": "pnpm --parallel --aggregate-output --reporter append-only --filter ./packages lint:fix",
-    "typecheck": "pnpm --parallel --aggregate-output --reporter append-only --filter ./packages typecheck",
-    "build": "tsc --build --verbose ./tsconfig.prod.json && pnpm run --parallel --filter ./packages post-build",
+    "lint": "pnpm run --parallel --aggregate-output --reporter append-only --filter './packages/**' lint",
+    "lint:fix": "pnpm --parallel --aggregate-output --reporter append-only --filter './packages/**' lint:fix",
+    "typecheck": "pnpm --parallel --aggregate-output --reporter append-only --filter './packages/**' typecheck",
+    "build": "tsc --build --verbose ./tsconfig.prod.json && pnpm run --parallel --filter './packages/**' post-build",
     "watch": "tsc --build --verbose --watch ./tsconfig.prod.json",
-    "clean": "pnpm --filter ./packages clean",
-    "compile-contracts": "ts-node --transpile-only ./scripts/compile-contracts && pnpm run --parallel --filter ./packages compile-contracts",
-    "test": "pnpm compile-contracts && pnpm run --parallel --aggregate-output --reporter append-only --filter ./packages test",
+    "clean": "pnpm --filter './packages/**' clean",
+    "compile-contracts": "ts-node --transpile-only ./scripts/compile-contracts && pnpm run --parallel --filter './packages/**' compile-contracts",
+    "test": "pnpm compile-contracts && pnpm run --parallel --aggregate-output --reporter append-only --filter './packages/**' test",
     "test:fix": "pnpm lint:fix && pnpm test && pnpm format:fix && pnpm typecheck",
     "no-git-changes": "./scripts/no-git-changes.sh",
     "check-examples": "ts-node --transpile-only ./scripts/check-examples.ts",
@@ -30,16 +31,21 @@
     "@typescript-eslint/parser": "4.15.1",
     "earljs": "0.2.2",
     "eslint": "^7.29.0",
-    "eslint-config-typestrict": "^1.0.2",
+    "eslint-config-typestrict": "^1.0.3",
     "eslint-plugin-import": "^2.23.4",
     "eslint-plugin-no-only-tests": "^2.6.0",
     "eslint-plugin-simple-import-sort": "^7.0.0",
-    "eslint-plugin-sonarjs": "^0.8.0-125",
+    "eslint-plugin-sonarjs": "^0.13.0",
     "eslint-plugin-unused-imports": "^1.1.1",
     "mocha": "^8.2.0",
     "prettier": "^2.3.1",
     "ts-node": "^10.7.0",
     "@types/node": "^14",
     "typescript": "^4.6"
+  },
+  "pnpm": {
+    "peerDependencyRules": {
+      "ignoreMissing": ["typescript", "@types/node"]
+    }
   }
 }
diff --git a/packages/target-truffle-v5-test/package.json b/packages/target-truffle-v5-test/package.json
@@ -36,6 +36,7 @@
     "web3-core": "^1",
     "web3-eth-contract": "^1",
     "web3-utils": "^1",
-    "web3": "^1"
+    "web3": "^1",
+    "@types/bn.js": "^4.11.6"
   }
 }
diff --git a/packages/target-web3-v1-test/package.json b/packages/target-web3-v1-test/package.json
@@ -20,6 +20,7 @@
     "typechain": "workspace:^8.0.0",
     "web3": "^1.6.0",
     "web3-eth-contract": "^1.6.0",
-    "web3-core": "^1"
+    "web3-core": "^1",
+    "@types/bn.js": "^4.11.6"
   }
 }
diff --git a/packages/target-web3-v1/package.json b/packages/target-web3-v1/package.json
@@ -42,7 +42,8 @@
     "@types/lodash": "^4.14.139",
     "web3": "^1",
     "web3-core": "^1",
-    "web3-eth-contract": "^1"
+    "web3-eth-contract": "^1",
+    "@types/bn.js": "^4.11.6"
   },
   "dependencies": {
     "lodash": "^4.17.15",
diff --git a/packages/test-e2e/package.json b/packages/test-e2e/package.json
@@ -14,6 +14,7 @@
   },
   "dependencies": {
     "fs-extra": "^9.1.0",
+    "@types/fs-extra": "^9.0.7",
     "typechain": "workspace:^8.0.0",
     "@typechain/ethers-v5": "workspace:^10.0.0"
   },
diff --git a/packages/test-utils/package.json b/packages/test-utils/package.json
@@ -17,10 +17,14 @@
     "test:fix": "pnpm lint:fix && pnpm format:fix && pnpm test && pnpm typecheck"
   },
   "dependencies": {
-    "ts-essentials": "^7.0.1",
-    "bignumber.js":"9.0.1",
+    "@types/glob": "7",
+    "@types/lodash": "^4.14.139",
+    "@types/retry-as-promised": "^2.3.3",
+    "bignumber.js": "9.0.1",
     "conditional-type-checks": "^1.0.5",
+    "glob": "7.1.7",
+    "lodash": "^4.17.15",
     "retry-as-promised": "^5.0.0",
-    "@types/retry-as-promised": "^2.3.3"
+    "ts-essentials": "^7.0.1"
   }
 }
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/scripts/compile-contracts.ts b/scripts/compile-contracts.ts

Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,7 @@`
`36`	`36`	`"web3-core": "^1",`
`37`	`37`	`"web3-eth-contract": "^1",`
`38`	`38`	`"web3-utils": "^1",`
`39`		`- "web3": "^1"`
	`39`	`+ "web3": "^1",`
	`40`	`+ "@types/bn.js": "^4.11.6"`
`40`	`41`	`}`
`41`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,7 @@`
`20`	`20`	`"typechain": "workspace:^8.0.0",`
`21`	`21`	`"web3": "^1.6.0",`
`22`	`22`	`"web3-eth-contract": "^1.6.0",`
`23`		`- "web3-core": "^1"`
	`23`	`+ "web3-core": "^1",`
	`24`	`+ "@types/bn.js": "^4.11.6"`
`24`	`25`	`}`
`25`	`26`	`}`