chore: specify pnpm version in package.json #1016

mikavilpas · 2024-09-05T05:54:26Z

Problem

It's possible to use a different version of pnpm than the one that is used in CI. This can lead to inconsistencies between the local development environment and the CI environment.

Solution

Specify the version of pnpm that is used in the engines field of package.json.

This results in an error message similar to the following when a different version of pnpm is used:

$ corepack prepare pnpm@latest --activate
$ pnpm i
 ERR_PNPM_UNSUPPORTED_ENGINE  Unsupported environment (bad pnpm and/or Node.js version)

Your pnpm version is incompatible with "/Users/mikavilpas/git/openapi-ts".

Expected version: 8.15.7
Got: 9.9.0

This is happening because the package's manifest has an engines.pnpm field specified.
To fix this issue, install the required pnpm version globally.

To install the latest version of pnpm, run "pnpm i -g pnpm".
To check your pnpm version, run "pnpm -v".

$ corepack prepare [email protected] --activate

Problem = It's possible to use a different version of pnpm than the one that is used in CI. This can lead to inconsistencies between the local development environment and the CI environment. Solution = Specify the version of pnpm that is used in the `engines` field of `package.json`. This results in an error message similar to the following when a different version of pnpm is used: ```sh $ corepack prepare pnpm@latest --activate $ pnpm i ERR_PNPM_UNSUPPORTED_ENGINE Unsupported environment (bad pnpm and/or Node.js version) Your pnpm version is incompatible with "/Users/mikavilpas/git/openapi-ts". Expected version: 8.15.7 Got: 9.9.0 This is happening because the package's manifest has an engines.pnpm field specified. To fix this issue, install the required pnpm version globally. To install the latest version of pnpm, run "pnpm i -g pnpm". To check your pnpm version, run "pnpm -v". $ corepack prepare [email protected] --activate ```

stackblitz · 2024-09-05T05:54:29Z

Run & review this pull request in StackBlitz Codeflow.

changeset-bot · 2024-09-05T05:54:30Z

⚠️ No Changeset found

Latest commit: f5a3339

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

vercel · 2024-09-05T05:54:30Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
hey-api-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Sep 5, 2024 11:51am

mikavilpas · 2024-09-05T05:55:48Z

Note that it may make sense to also upgrade the version in these places instead as there seem to be some errors

.github/workflows/ci.yml|27 col 20| version: 8.15.7
.github/workflows/release.yml|26 col 20| version: 8.15.7
.github/workflows/coverage.yml|26 col 20| version: 8.15.7

mikavilpas · 2024-09-05T05:57:55Z

I forgot to attach the docs. They can be found here https://pnpm.io/package_json

mrlubos · 2024-09-05T06:40:42Z

pnpm-lock.yaml

Why are there changes in the lock file? Is that correct?

It might be happening if my environment is somehow different... Are you using pnpm version 8.15.7 or something else?

I also get this extra output so maybe my environment is missing some step 🤔

Details

  ~/git/openapi-ts   specify-pnpm-version $✘   v20.10.0  󱑎 14:45  $ pnpm i Scope: all 11 workspace projects WARN 7 deprecated subdependencies found: @humanwhocodes/[email protected], @humanwhocodes/[email protected], [email protected], [email protected], [email protected], [email protected], [email protected] Already up to date Progress: resolved 1572, reused 1491, downloaded 0, added 0, done . prepare$ husky └─ Done in 238ms .../openapi-ts-tanstack-svelte-query prepare$ svelte-kit sync └─ Done in 667ms WARN Issues with peer dependencies found . ├─┬ @typescript-eslint/eslint-plugin 7.15.0 │ ├── ✕ unmet peer eslint@^8.56.0: found 9.6.0 │ └─┬ @typescript-eslint/type-utils 7.15.0 │ ├── ✕ unmet peer eslint@^8.56.0: found 9.6.0 │ └─┬ @typescript-eslint/utils 7.15.0 │ └── ✕ unmet peer eslint@^8.56.0: found 9.6.0 ├─┬ eslint-plugin-typescript-sort-keys 3.2.0 │ ├── ✕ unmet peer eslint@"^7 || ^8": found 9.6.0 │ └─┬ @typescript-eslint/experimental-utils 5.62.0 │ ├── ✕ unmet peer eslint@"^6.0.0 || ^7.0.0 || ^8.0.0": found 9.6.0 │ └─┬ @typescript-eslint/utils 5.62.0 │ └── ✕ unmet peer eslint@"^6.0.0 || ^7.0.0 || ^8.0.0": found 9.6.0 ├─┬ eslint-plugin-vue 9.23.0 │ └── ✕ unmet peer eslint@"^6.2.0 || ^7.0.0 || ^8.0.0": found 9.6.0 └─┬ typescript-eslint 7.15.0 ├── ✕ unmet peer eslint@^8.56.0: found 9.6.0 ├─┬ @typescript-eslint/eslint-plugin 7.15.0 │ └── ✕ unmet peer eslint@^8.56.0: found 9.6.0 └─┬ @typescript-eslint/parser 7.15.0 └── ✕ unmet peer eslint@^8.56.0: found 9.6.0 examples/openapi-ts-axios ├─┬ @typescript-eslint/eslint-plugin 7.15.0 │ ├── ✕ unmet peer eslint@^8.56.0: found 9.6.0 │ └─┬ @typescript-eslint/type-utils 7.15.0 │ ├── ✕ unmet peer eslint@^8.56.0: found 9.6.0 │ └─┬ @typescript-eslint/utils 7.15.0 │ └── ✕ unmet peer eslint@^8.56.0: found 9.6.0 ├─┬ @typescript-eslint/parser 7.15.0 │ └── ✕ unmet peer eslint@^8.56.0: found 9.6.0 └─┬ eslint-plugin-react-hooks 4.6.2 └── ✕ unmet peer eslint@"^3.0.0 || ^4.0.0 || ^5.0.0 || ^6.0.0 || ^7.0.0 || ^8.0.0-0": found 9.6.0 examples/openapi-ts-fetch ├─┬ @typescript-eslint/eslint-plugin 7.15.0 │ ├── ✕ unmet peer eslint@^8.56.0: found 9.6.0 │ └─┬ @typescript-eslint/type-utils 7.15.0 │ ├── ✕ unmet peer eslint@^8.56.0: found 9.6.0 │ └─┬ @typescript-eslint/utils 7.15.0 │ └── ✕ unmet peer eslint@^8.56.0: found 9.6.0 ├─┬ @typescript-eslint/parser 7.15.0 │ └── ✕ unmet peer eslint@^8.56.0: found 9.6.0 └─┬ eslint-plugin-react-hooks 4.6.2 └── ✕ unmet peer eslint@"^3.0.0 || ^4.0.0 || ^5.0.0 || ^6.0.0 || ^7.0.0 || ^8.0.0-0": found 9.6.0 examples/openapi-ts-tanstack-react-query ├─┬ @typescript-eslint/eslint-plugin 7.15.0 │ ├── ✕ unmet peer eslint@^8.56.0: found 9.6.0 │ └─┬ @typescript-eslint/type-utils 7.15.0 │ ├── ✕ unmet peer eslint@^8.56.0: found 9.6.0 │ └─┬ @typescript-eslint/utils 7.15.0 │ └── ✕ unmet peer eslint@^8.56.0: found 9.6.0 ├─┬ @typescript-eslint/parser 7.15.0 │ └── ✕ unmet peer eslint@^8.56.0: found 9.6.0 └─┬ eslint-plugin-react-hooks 4.6.2 └── ✕ unmet peer eslint@"^3.0.0 || ^4.0.0 || ^5.0.0 || ^6.0.0 || ^7.0.0 || ^8.0.0-0": found 9.6.0 examples/openapi-ts-tanstack-vue-query └─┬ @vue/eslint-config-typescript 13.0.0 ├── ✕ unmet peer eslint@^8.56.0: found 9.6.0 ├─┬ @typescript-eslint/eslint-plugin 7.15.0 │ ├── ✕ unmet peer eslint@^8.56.0: found 9.6.0 │ └─┬ @typescript-eslint/type-utils 7.15.0 │ ├── ✕ unmet peer eslint@^8.56.0: found 9.6.0 │ └─┬ @typescript-eslint/utils 7.15.0 │ └── ✕ unmet peer eslint@^8.56.0: found 9.6.0 └─┬ @typescript-eslint/parser 7.15.0 └── ✕ unmet peer eslint@^8.56.0: found 9.6.0 packages/openapi-ts ├─┬ @angular-devkit/build-angular 17.3.7 │ ├── ✕ unmet peer typescript@">=5.2 <5.5": found 5.5.3 │ └─┬ @ngtools/webpack 17.3.7 │ └── ✕ unmet peer typescript@">=5.2 <5.5": found 5.5.3 └─┬ @angular/compiler-cli 17.3.9 └── ✕ unmet peer typescript@">=5.2 <5.5": found 5.5.3 Done in 3.8s

mrlubos · 2024-09-05T06:41:11Z

package.json

@@ -31,7 +31,8 @@
    "typecheck": "pnpm --recursive typecheck"
  },
  "engines": {
-    "node": "^18.0.0 || >=20.0.0"
+    "node": "^18.0.0 || >=20.0.0",
+    "pnpm": "8.15.7"


Do you think this should also be a range?

I changed it to >=8 <9 which should allow for some leeway.

mrlubos · 2024-09-05T06:44:17Z

Note that it may make sense to also upgrade the version in these places instead as there seem to be some errors
.github/workflows/ci.yml|27 col 20| version: 8.15.7

.github/workflows/release.yml|26 col 20| version: 8.15.7

.github/workflows/coverage.yml|26 col 20| version: 8.15.7

Yeah we definitely want the build to pass. Here's the error message in case you can't see it

Using package.json#engines.pnpm without corepack and package.json#packageManager could lead to failed builds with ERR_PNPM_UNSUPPORTED_ENGINE. Learn more: https://vercel.com/docs/errors/error-list#pnpm-engine-unsupported
 ERR_PNPM_UNSUPPORTED_ENGINE  Unsupported environment (bad pnpm and/or Node.js version)

codecov · 2024-09-05T11:47:18Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.19%. Comparing base (386da70) to head (49b1cbf).
Report is 2 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1016   +/-   ##
=======================================
  Coverage   76.19%   76.19%           
=======================================
  Files          89       89           
  Lines       10973    10973           
  Branches     1113     1113           
=======================================
  Hits         8361     8361           
  Misses       2605     2605           
  Partials        7        7

Flag	Coverage Δ
unittests	`76.19% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

pkg-pr-new · 2024-09-05T11:49:06Z

Open in Stackblitz

pnpm add https://pkg.pr.new/@hey-api/client-axios@1016

pnpm add https://pkg.pr.new/@hey-api/client-fetch@1016

pnpm add https://pkg.pr.new/@hey-api/openapi-ts@1016

commit: 49b1cbf

Following the instructions in https://vercel.com/docs/errors/error-list#pnpm-engine-unsupported It should fix the error: ```text Using package.json#engines.pnpm without corepack and package.json#packageManager could lead to failed builds with ERR_PNPM_UNSUPPORTED_ENGINE. Learn more: https://vercel.com/docs/errors/error-list#pnpm-engine-unsupported ERR_PNPM_UNSUPPORTED_ENGINE Unsupported environment (bad pnpm and/or Node.js version) ``` ```

vercel bot had a problem deploying to Preview September 5, 2024 05:54 Failure

mrlubos reviewed Sep 5, 2024

View reviewed changes

chore: use pnpm version >=8 <9 for development

49b1cbf

vercel bot deployed to Preview September 5, 2024 11:45 View deployment

vercel bot deployed to Preview September 5, 2024 11:51 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: specify pnpm version in package.json #1016

chore: specify pnpm version in package.json #1016

mikavilpas commented Sep 5, 2024

stackblitz bot commented Sep 5, 2024

changeset-bot bot commented Sep 5, 2024 •

edited

Loading

vercel bot commented Sep 5, 2024 •

edited

Loading

mikavilpas commented Sep 5, 2024

mikavilpas commented Sep 5, 2024

mrlubos Sep 5, 2024

mikavilpas Sep 5, 2024

mrlubos Sep 5, 2024

mikavilpas Sep 5, 2024

mrlubos commented Sep 5, 2024

codecov bot commented Sep 5, 2024

pkg-pr-new bot commented Sep 5, 2024

chore: specify pnpm version in package.json #1016

Are you sure you want to change the base?

chore: specify pnpm version in package.json #1016

Conversation

mikavilpas commented Sep 5, 2024

Problem

Solution

stackblitz bot commented Sep 5, 2024

changeset-bot bot commented Sep 5, 2024 • edited Loading

⚠️ No Changeset found

vercel bot commented Sep 5, 2024 • edited Loading

mikavilpas commented Sep 5, 2024

mikavilpas commented Sep 5, 2024

mrlubos Sep 5, 2024

Choose a reason for hiding this comment

mikavilpas Sep 5, 2024

Choose a reason for hiding this comment

mrlubos Sep 5, 2024

Choose a reason for hiding this comment

mikavilpas Sep 5, 2024

Choose a reason for hiding this comment

mrlubos commented Sep 5, 2024

codecov bot commented Sep 5, 2024

Codecov Report

pkg-pr-new bot commented Sep 5, 2024

changeset-bot bot commented Sep 5, 2024 •

edited

Loading

vercel bot commented Sep 5, 2024 •

edited

Loading