chore: migrate to pnpm (#663)

Tom Lienard · web-flow · commit 8d84d9b17a7b · 2022-03-11T17:33:07.000+01:00
* feat: migrate to pnpm

* fix: pnpm-lock deps version

* fix: snapshots

* fix: hoisted deps

* fix: resolve review

* fix: add back workspaces for lerna

* fix: packageManager field

* chore(docs): use pnpm

* ci: pnpm/action-setup version

* fix: resolve review
diff --git a/.github/renovate.json b/.github/renovate.json
@@ -7,7 +7,6 @@
   "reviewersSampleSize": 2,
   "prHourlyLimit": 5,
   "prConcurrentLimit": 10,
-  "postUpdateOptions": ["yarnDedupeHighest"],
   "labels": ["dependencies"],
   "rangeStrategy": "pin",
   "semanticCommitType": "chore",
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -7,44 +7,47 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
     - uses: actions/checkout@v3.0.0
+    - uses: pnpm/action-setup@v2.2.1
     - name: Use Node.js
       uses: actions/setup-node@v3.0.0
       with:
         node-version: 17
         check-latest: true
-        cache: 'yarn'
-    - run: yarn
-    - run: yarn run build
-    - run: yarn run tsc --noEmit
+        cache: 'pnpm'
+    - run: pnpm install
+    - run: pnpm run build
+    - run: pnpm tsc --noEmit
   lint:
     runs-on: ubuntu-20.04
     steps:
     - uses: actions/checkout@v3.0.0
+    - uses: pnpm/action-setup@v2.2.1
     - name: Use Node.js
       uses: actions/setup-node@v3.0.0
       with:
         node-version: 17
         check-latest: true
-        cache: 'yarn'
-    - run: yarn
-    - run: yarn run build
-    - run: yarn run lint
+        cache: 'pnpm'
+    - run: pnpm install
+    - run: pnpm run build
+    - run: pnpm run lint
   test:
     runs-on: ubuntu-20.04
     strategy:
       matrix:
         node: [ '14', '16', '17' ]
     steps:
     - uses: actions/checkout@v3.0.0
+    - uses: pnpm/action-setup@v2.2.1
     - name: Use Node.js
       uses: actions/setup-node@v3.0.0
       with:
         node-version: ${{ matrix.node }}
         check-latest: true
-        cache: 'yarn'
-    - run: yarn
-    - run: yarn run build
-    - run: yarn run test:coverage
+        cache: 'pnpm'
+    - run: pnpm install
+    - run: pnpm run build
+    - run: pnpm run test:coverage
     - uses: codecov/codecov-action@v2.1.0
   deploy:
     runs-on: ubuntu-20.04
@@ -63,17 +66,18 @@ jobs:
         git remote set-url origin https://x-access-token:${GITHUB_TOKEN}@github.com/$GITHUB_REPOSITORY
       env:
         GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+    - uses: pnpm/action-setup@v2.2.1
     - name: Use Node.js
       uses: actions/setup-node@v3.0.0
       with:
         node-version: 17
         check-latest: true
-    - run: yarn --immutable --inline-builds
-    - run: yarn run build
+    - run: pnpm install
+    - run: pnpm run build
     - run: echo //registry.npmjs.org/:_authToken=${NPM_TOKEN} > .npmrc
       env:
         NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-    - run: yarn run lerna publish -y --create-release github --ignore-scripts --no-verify-access
+    - run: pnpm lerna publish -y --create-release github --ignore-scripts --no-verify-access
       env:
         HUSKY: 0
         GH_TOKEN: ${{ secrets.GH_TOKEN }}
diff --git a/.github/workflows/pull_request_title.yml b/.github/workflows/pull_request_title.yml
@@ -9,11 +9,12 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
     - uses: actions/checkout@v3.0.0
+    - uses: pnpm/action-setup@v2.2.1
     - name: Use Node.js
       uses: actions/setup-node@v3.0.0
       with:
         node-version: 17
         check-latest: true
-        cache: 'yarn'
-    - run: yarn
-    - run: echo '${{ github.event.pull_request.title }}' | yarn run commitlint
+        cache: 'pnpm'
+    - run: pnpm install
+    - run: echo '${{ github.event.pull_request.title }}' | pnpm commitlint
diff --git a/.gitignore b/.gitignore
@@ -1,15 +1,9 @@
 # dependencies
 node_modules
-.yarn/*
-!.yarn/patches
-!.yarn/releases
-!.yarn/plugins
-!.yarn/sdks
-!.yarn/versions
-.pnp.*
-
-# we are using yarn here
+
+# we are using pnpm here
 package-lock.json
+yarn.lock
 
 # misc
 .DS_Store
diff --git a/.husky/commit-msg b/.husky/commit-msg
@@ -1,5 +1,5 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-yarn commitlint --edit $1
+pnpm commitlint --edit $1
 
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -1,4 +1,4 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-yarn run lint-staged
+pnpm lint-staged
diff --git a/.husky/pre-push b/.husky/pre-push
@@ -1,4 +1,4 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-yarn run lint-staged
+pnpm lint-staged
diff --git a/.yarn/releases/yarn-3.2.0.cjs b/.yarn/releases/yarn-3.2.0.cjs
diff --git a/.yarnrc.yml b/.yarnrc.yml
diff --git a/README.md b/README.md
@@ -15,7 +15,7 @@ scaleway-lib is a set of NPM packages used at Scaleway.
 - [Development](#development)
   - [Locally](#locally)
   - [Link against another project (with `yalc`) => FAVORED](#link-against-another-project-with-yalc--favored)
-  - [Link against another project (with `yarn link`)](#link-against-another-project-with-yarn-link)
+  - [Link against another project (with `pnpm link`)](#link-against-another-project-with-pnpm-link)
   - [Linting](#linting)
   - [Unit Test](#unit-test)
 - [Lerna](#lerna)
@@ -98,75 +98,75 @@ scaleway-lib is a set of NPM packages used at Scaleway.
 ```bash
 $ git clone git@github.com:scaleway/scaleway-lib.git
 $ cd scaleway-lib
-$ yarn
+$ pnpm install
 $ # ... do your changes ...
-$ yarn run lint
-$ yarn run test
+$ pnpm run lint
+$ pnpm run test
 ```
 
 ### Link against another project (with `yalc`) => FAVORED
 
-> [`yalc`](https://github.com/whitecolor/yalc) is a tool aiming to simplify working with local npm packages by providing a different workflow than `npm/yarn link`, hence avoiding most of their issues with module resolving.
+> [`yalc`](https://github.com/whitecolor/yalc) is a tool aiming to simplify working with local npm packages by providing a different workflow than `npm/yarn/pnpm link`, hence avoiding most of their issues with module resolving.
 
 ```bash
-$ yarn global add yalc # Make sure to have the yalc binary
+$ pnpm install -g yalc # Make sure to have the yalc binary
 ```
 
 ```bash
 $ cd scaleway-lib/packages/example_package
-$ yarn build && yalc publish
+$ pnpm run build && yalc publish
 $ # Now it's ready to install in your project
 $ cd ../../../project-something
-$ yalc add @scaleway/package-name --yarn
+$ yalc add @scaleway/package-name
 $ cd ../scaleway-lib/packages/example_package
 $ # If you do some changes into your package
-$ yarn build && yalc publish --push --sig # --push will automatically update the package on projects where it have been added, --sig updates the signature hash to trigger webpack update
+$ pnpm run build && yalc publish --push --sig # --push will automatically update the package on projects where it have been added, --sig updates the signature hash to trigger webpack update
 ```
 
 > :warning: since [1.0.0.pre.51 (2021-04-23)](https://github.com/wclr/yalc/blob/master/CHANGELOG.md#100pre51-2021-04-23), `yalc publish` needs the `--sig` option to trigger webpack module actual update.
 
 > :warning: `yalc` create a `yalc.lock` and updates the `package.json` in the target project. **Make sure to not commit these changes**
 
-### Link against another project (with `yarn link`)
+### Link against another project (with `pnpm link`)
 
 ```bash
-$ cd packages/example_package && yarn link
-$ cd - && yarn run build # rebuild the package
+$ cd packages/example_package && pnpm link
+$ cd - && pnpm run build # rebuild the package
 $ # Now it's ready to link into your project
 $ cd ../project-something
-$ yarn link @scaleway/example_package
+$ pnpm link @scaleway/example_package
 ```
 
 ### Linting
 
 ```bash
-$ yarn run lint
-$ yarn run lint:fix
+$ pnpm run lint
+$ pnpm run lint:fix
 ```
 
 ### Unit Test
 
 ```bash
-$ yarn run test # Will run all tests
-$ yarn run test --updateSnapshot # Will update all snapshots
-$ yarn run test:watch # Will watch tests and only rerun the one who are modified
-$ yarn run test:coverage # Will generate a coverage report
+$ pnpm run test # Will run all tests
+$ pnpm run test -- --updateSnapshot # Will update all snapshots
+$ pnpm run test:watch # Will watch tests and only rerun the one who are modified
+$ pnpm run test:coverage # Will generate a coverage report
 ```
 
 ## Lerna
 
 This project is managed with [Lerna](https://lerna.js.org). Lerna is a tool to manage multiple NPM packages inside the same repository.
 
-Lerna also allows us to use [Yarn workspaces](https://classic.yarnpkg.com/en/docs/workspaces/) to manage our dependencies. This implies a few things:
+Lerna also allows us to use [PNPM workspaces](https://pnpm.io/workspaces) to manage our dependencies. This implies a few things:
 
 - devDependencies should be included in top package.json
-- There should be no `node_modules` or `yarn.lock` in sub-packages
+- There should be no `node_modules` or `pnpm-lock.yml` in sub-packages
 - There is a special syntax to manage sub-packages dependencies:
 
 ```bash
-$ yarn add -W -D new_dependency # Add a new devDependency to root project
-$ yarn workspace @scaleway/package_name add new_dependency
-$ yarn workspace @scaleway/package_name remove old_dependency
+$ pnpm add -W -D new_dependency # Add a new devDependency to root project
+$ cd packages/package_name && pnpm add new_dependency
+$ cd packages/package_name && pnpm remove old_dependency
 ```
 
 ## Notes
diff --git a/lerna.json b/lerna.json
@@ -1,7 +1,7 @@
 {
   "packages": ["packages/*"],
   "useWorkspaces": true,
-  "npmClient": "yarn",
+  "npmClient": "pnpm",
   "version": "independent",
   "command": {
     "publish": {
diff --git a/package.json b/package.json
@@ -41,13 +41,13 @@
   },
   "scripts": {
     "lint": "eslint --ext js,ts,tsx --cache .",
-    "lint:fix": "yarn run lint --fix",
+    "lint:fix": "pnpm run lint -- --fix",
     "build": "lerna exec --stream --ignore @scaleway/eslint-config-react --ignore @scaleway/countries -- rollup -c ../../rollup.config.mjs",
-    "build:profile": "cross-env PROFILE=true yarn run build",
+    "build:profile": "cross-env PROFILE=true pnpm run build",
     "commit": "npx git-cz -a",
     "test": "TZ=UTC jest",
-    "test:watch": "yarn run test --watch",
-    "test:coverage": "yarn run test --coverage",
+    "test:watch": "pnpm run test -- --watch",
+    "test:coverage": "pnpm run test -- --coverage",
     "prepare": "husky install"
   },
   "commitlint": {
@@ -92,5 +92,5 @@
       ]
     ]
   },
-  "packageManager": "yarn@3.2.0"
+  "packageManager": "pnpm@6.16.0"
 }
diff --git a/packages/countries/README.md b/packages/countries/README.md
@@ -9,7 +9,7 @@ This package only holds and publish json files
 ## Install
 
 ```bash
-$ yarn add @scaleway/countries
+$ pnpm add @scaleway/countries
 ```
 
 ## Usage
@@ -34,5 +34,5 @@ To update the database, first make sure that you have:
 And then:
 
 ```bash
-$ yarn run generate
+$ pnpm run generate
 ```
diff --git a/packages/countries/generate.py b/packages/countries/generate.py
@@ -7,7 +7,7 @@
 # Usage:
 #   $ poetry install && poetry run python generate.py
 # Or simply from the package.json
-#   $ yarn run generate
+#   $ pnpm run generate
 
 import pycountry
 import json
diff --git a/packages/eslint-config-react/README.md b/packages/eslint-config-react/README.md
@@ -9,7 +9,7 @@ Available in Javascript and Typescript
 ## Install
 
 ```bash
-$ yarn add --dev @scaleway/eslint-config-react
+$ pnpm add --dev @scaleway/eslint-config-react
 ```
 
 ## Usage
diff --git a/packages/jest-helpers/README.md b/packages/jest-helpers/README.md
@@ -5,7 +5,7 @@
 ## Install
 
 ```bash
-$ yarn add @scaleway/jest-functions
+$ pnpm add @scaleway/jest-functions
 ```
 
 ## How to use
diff --git a/packages/random-name/README.md b/packages/random-name/README.md
@@ -9,7 +9,7 @@ Fully inspired by [Moby name generator](https://github.com/moby/moby/blob/master
 ## Install
 
 ```bash
-$ yarn add @scaleway/random-name
+$ pnpm add @scaleway/random-name
 ```
 
 ## Usage
diff --git a/packages/regex/README.md b/packages/regex/README.md
@@ -7,7 +7,7 @@ A tiny utility to use named regex
 ## Install
 
 ```bash
-$ yarn add @scaleway/regex
+$ pnpm add @scaleway/regex
 ```
 
 ## Usage
diff --git a/packages/use-dataloader/README.md b/packages/use-dataloader/README.md
@@ -9,7 +9,7 @@
 ## Install
 
 ```bash
-$ yarn add @scaleway/use-dataloader
+$ pnpm add @scaleway/use-dataloader
 ```
 
 ## How to use
diff --git a/packages/use-i18n/README.md b/packages/use-i18n/README.md
@@ -5,7 +5,7 @@
 ## Install
 
 ```bash
-$ yarn add @scaleway/use-i18n
+$ pnpm add @scaleway/use-i18n
 ```
 
 ## Usage
diff --git a/packages/use-query-params/README.md b/packages/use-query-params/README.md
@@ -5,7 +5,7 @@
 ## Install
 
 ```bash
-$ yarn add @scaleway/use-query-params react-router-dom
+$ pnpm add @scaleway/use-query-params react-router-dom
 ```
 
 ## Usage
diff --git a/packages/use-random-name/README.md b/packages/use-random-name/README.md
@@ -9,7 +9,7 @@ Fully inspired by [Moby name generator](https://github.com/moby/moby/blob/master
 ## Install
 
 ```bash
-$ yarn add @scaleway/use-random-name
+$ pnpm add @scaleway/use-random-name
 ```
 
 ## Usage
diff --git a/packages/use-segment/README.md b/packages/use-segment/README.md
@@ -7,7 +7,7 @@ use [@segment/analytics-next](https://github.com/segmentio/analytics-next)
 ## Install
 
 ```bash
-$ yarn add @scaleway/use-segment
+$ pnpm add @scaleway/use-segment
 ```
 
 ## Usage
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml
diff --git a/yarn.lock b/yarn.lock
