Migrate to pnpm (#10818)

* Switch packageManager

* Update lock and workspace files

* Update root files

* Migrate workflows to PNPM

* Update examples and docs

* Link exmaples codegen CLI to workspace version

* Re-import yarn.lock

* Remove explicit types default in validateTs function

* Fix packageManager in CI

* Correctly overrides typescript-eslint packages

* Add dotenv package specifically for dev runs

* Downgrade pnpm to work with node 20 (minimum support version)

* Fix ci issues

* Install root devDeps for dev-test

* Fix installation in CI with frozen lockfile

* Fix package issues for CI

* Put FIXMEs to pass tests

* Sync versions and fix cjs esm issues

* Put pack dedupe lockfile

* Fix lint

* Fix website script, revert to TS 5.9.3 to match typescript-json-schema requirements

* ESM-first

* Prepare Cypress

* More ESM-first

* Prepare Cypress 2

Author: eddeee888

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -80,7 +80,7 @@ body:
         After reading the [Contributor Workflow](https://github.com/the-guild-org/Stack/blob/master/CONTRIBUTING.md#a-typical-contributor-workflow), Check out and update the current state of this issue:
 
         - [ ] 1. The issue provides a [minimal reproduction](https://stackoverflow.com/help/minimal-reproducible-example) available on [GitHub](https://github.com/dotansimha/graphql-code-generator-issue-sandbox-template), [Stackblitz](https://stackblitz.com/github/dotansimha/graphql-code-generator-issue-sandbox-template) or [CodeSandbox](https://codesandbox.io/s/github/dotansimha/graphql-code-generator-issue-sandbox-template).
-          - _Make sure to fork this template and run `yarn generate` in the terminal._
+          - _Make sure to fork this template and run `pnpm generate` in the terminal._
           - _Please make sure the Codegen and plugins version under `package.json` matches yours._
         - [ ] 2. A failing test has been provided
         - [ ] 3. A local solution has been provided

.github/workflows/main.yml

@@ -22,7 +22,8 @@ jobs:
     name: Linting Check
     uses: the-guild-org/shared-config/.github/workflows/lint.yml@f4eea983237a44bb0ca19c3348dacbfdfcdbec23 # main
     with:
-      script: yarn ci:lint
+      script: pnpm ci:lint
+      packageManager: pnpm
     secrets:
       githubToken: ${{ secrets.GITHUB_TOKEN }}
   prettier-check:
@@ -33,8 +34,10 @@ jobs:
         uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
       - name: Setup env
         uses: the-guild-org/shared-config/setup@f4eea983237a44bb0ca19c3348dacbfdfcdbec23 # main
+        with:
+          packageManager: pnpm
       - name: Prettier Check
-        run: yarn prettier:check
+        run: pnpm prettier:check
   dev-tests-old:
     name: Validating dev-tests
     runs-on: ubuntu-latest
@@ -48,13 +51,15 @@ jobs:
         uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
       - name: Setup env
         uses: the-guild-org/shared-config/setup@f4eea983237a44bb0ca19c3348dacbfdfcdbec23 # main
+        with:
+          packageManager: pnpm
       - name: Build
-        run: yarn build
+        run: pnpm build
         env:
           CI: true
       - name: Test dev-tests ${{matrix.method}}
         run: |
-          yarn run generate:examples:${{matrix.method}}
+          pnpm run generate:examples:${{matrix.method}}
           git diff --exit-code -- dev-test/
   dev-tests:
     name: Examples - Normal
@@ -64,20 +69,28 @@ jobs:
         uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
       - name: Setup env
         uses: the-guild-org/shared-config/setup@f4eea983237a44bb0ca19c3348dacbfdfcdbec23 # main
+        with:
+          packageManager: pnpm
+      - name: Prepare Cypress
+        run: |
+          pnpm store prune
+          pnpm config set side-effects-cache false --location project
+          pnpm rm -rf node_modules
+          pnpm i
       - name: Build
-        run: yarn build
+        run: pnpm build
         env:
           CI: true
       - name: Generate and Diff Codegen Artifacts
         run: |
-          EXAMPLE_TYPE=normal yarn examples:codegen
+          EXAMPLE_TYPE=normal pnpm examples:codegen
           git diff --exit-code -- examples/
       - name: Build Examples
         run: |
-          EXAMPLE_TYPE=normal yarn examples:build
+          EXAMPLE_TYPE=normal pnpm examples:build
       - name: End2End Test Examples
         run: |
-          EXAMPLE_TYPE=normal yarn examples:test:end2end
+          EXAMPLE_TYPE=normal pnpm examples:test:end2end
 
   # TODO: Remove all SWC test setup and references as that has been moved to https://github.com/swc-project/plugins/tree/main/contrib/graphql-codegen-client-preset
   # dev-tests-swc:
@@ -120,12 +133,14 @@ jobs:
         uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
       - name: Setup env
         uses: the-guild-org/shared-config/setup@f4eea983237a44bb0ca19c3348dacbfdfcdbec23 # main
+        with:
+          packageManager: pnpm
       - name: Build
-        run: yarn build
+        run: pnpm build
         env:
           CI: true
       - name: Test ESM & CJS integrity
-        run: yarn bob check
+        run: pnpm bob check
   test:
     name:
       Unit Test on Node ${{matrix.node_version}} (${{matrix.os}}) and GraphQL
@@ -151,15 +166,16 @@ jobs:
         uses: the-guild-org/shared-config/setup@f4eea983237a44bb0ca19c3348dacbfdfcdbec23 # main
         with:
           nodeVersion: ${{matrix.node_version}}
+          packageManager: pnpm
       - name: Use GraphQL v${{matrix.graphql_version}}
         run: node ./scripts/match-graphql.js ${{matrix.graphql_version}}
       - name: Install Dependencies
-        run: yarn
+        run: pnpm i --no-frozen-lockfile
       - name: Build
-        run: yarn build
+        run: pnpm build
       - name: Test
         # FIXME: Do not test `watcher.run.spec.ts` here because it is currently not working for Node22+ in Ubuntu
-        run: yarn test --exclude="**/tests/watcher.run.spec.ts"
+        run: pnpm test --exclude="**/tests/watcher.run.spec.ts"
         env:
           CI: true
 
@@ -188,15 +204,16 @@ jobs:
         uses: the-guild-org/shared-config/setup@f4eea983237a44bb0ca19c3348dacbfdfcdbec23 # main
         with:
           nodeVersion: ${{matrix.node_version}}
+          packageManager: pnpm
       - name: Use GraphQL v${{matrix.graphql_version}}
         run: node ./scripts/match-graphql.js ${{matrix.graphql_version}}
       - name: Install Dependencies
-        run: yarn
+        run: pnpm i --no-frozen-lockfile
       - name: Build
-        run: yarn build
+        run: pnpm build
       - name: Test
         # FIXME: Merge `watcher.run.spec.ts` test to the above when it works for Node22+ in Ubuntu
-        run: yarn test packages/graphql-codegen-cli/tests/watcher.run.spec.ts
+        run: pnpm test packages/graphql-codegen-cli/tests/watcher.run.spec.ts
         env:
           CI: true
 

.github/workflows/pr.yml

@@ -26,6 +26,7 @@ jobs:
     with:
       npmTag: alpha
       buildScript: build
+      packageManager: pnpm
     secrets:
       githubToken: ${{ secrets.GITHUB_TOKEN }}
       npmToken: ${{ secrets.NPM_TOKEN }}
@@ -37,6 +38,7 @@ jobs:
       npmTag: rc
       restoreDeletedChangesets: true
       buildScript: build
+      packageManager: pnpm
     secrets:
       githubToken: ${{ secrets.GITHUB_TOKEN }}
       npmToken: ${{ secrets.NPM_TOKEN }}

.github/workflows/release.yml

@@ -14,6 +14,5 @@ jobs:
     with:
       releaseScript: release
     secrets:
-      # githubToken: ${{ secrets.GUILD_BOT_TOKEN }}
       githubToken: ${{ secrets.GITHUB_TOKEN }}
       npmToken: ${{ secrets.NPM_TOKEN }}

.github/workflows/website-integrity.yml

@@ -20,12 +20,14 @@ jobs:
 
       - name: Setup env
         uses: the-guild-org/shared-config/setup@f4eea983237a44bb0ca19c3348dacbfdfcdbec23 # main
+        with:
+          packageManager: pnpm
 
       - name: Build Packages
-        run: yarn build
+        run: pnpm build
 
       - name: Build Website
-        run: yarn workspace website run build
+        run: pnpm --filter=website run build
 
       - name: Compare
         run: git diff origin/${{ github.base_ref }}.. -- website/route-lockfile.txt

.github/workflows/website.yml

@@ -26,6 +26,8 @@ jobs:
 
       - uses: the-guild-org/shared-config/setup@f4eea983237a44bb0ca19c3348dacbfdfcdbec23 # main
         name: setup env
+        with:
+          packageManager: pnpm
 
       - uses: the-guild-org/shared-config/website-cf@f4eea983237a44bb0ca19c3348dacbfdfcdbec23 # main
         name: build and deploy website
@@ -41,5 +43,5 @@ jobs:
           projectName: graphql-code-generator
           prId: ${{ github.event.pull_request.number }}
           websiteDirectory: ./
-          buildScript: yarn build && cd website && yarn build
+          buildScript: pnpm build && cd website && pnpm build
           artifactDir: website/out

.gitignore

@@ -1,6 +1,5 @@
 .idea/
 .npmrc
-.yarnclean
 .DS_Store
 coverage
 *.log
@@ -12,7 +11,6 @@ dist/
 out.txt
 .cache
 tsconfig.tsbuildinfo
-.yarn/
 recompile.sh
 
 .next/

.husky/pre-commit

@@ -1 +1 @@
-yarn lint-staged
+pnpm lint-staged

.prettierignore

@@ -8,6 +8,7 @@ build/
 CHANGELOG.md
 .husky/_/
 .changeset/*.md
+pnpm-lock.yaml
 
 # temporarily ignore follow files because prettier-ignore comments don't work in mdx2
 # see https://github.com/prettier/prettier/pull/12208