feat(infra): adopt `pnpm` #7662

bmuenzenmeyer · 2025-04-17T21:42:19Z

Tasks from Vote

Add pnpm to README and docs
Add package-lock.json to .gitignore
Use pnpm in CI
Check pnpm-lock.yaml in CI
- This is always done when installing from a CI environment, see https://pnpm.io/cli/install#--frozen-lockfile
Add devEngines and packageManager to package.json

vercel · 2025-04-17T21:42:24Z

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

Name	Status	Preview	Updated (UTC)
nodejs-org	❌ Failed (Inspect)		Apr 25, 2025 11:43pm

bmuenzenmeyer · 2025-04-18T15:49:09Z

running full ci just for fun

avivkeller · 2025-04-18T17:59:33Z

running full ci just for fun

FWIW because this changes the pull_request_target workflows, a full CI will almost certainly fail every time (as the main branch CI doesn't set up pnpm). What I would do is, add a workflow_dispatch trigger to each of the CIs you want to test, and trigger them with:

gh workflow run lint-and-tests.yml --ref pnpm

Before merging, just remove the trigger.

.github/workflows/lint-and-tests.yml

avivkeller · 2025-04-24T20:41:18Z

Locally with npm:

> cd apps/site
> npm install --omit=dev --include-workspace-root
> npm run dev

Runs fine

ovflowd · 2025-04-24T20:42:39Z

npm error code EBADDEVENGINES
npm error EBADDEVENGINES The developer of this package has specified the following through devEngines
npm error EBADDEVENGINES Invalid engine "packageManager"
npm error EBADDEVENGINES Invalid name "pnpm" does not match "npm" for "packageManager"
npm error EBADDEVENGINES {
npm error EBADDEVENGINES   current: { name: 'npm', version: '10.9.2' },
npm error EBADDEVENGINES   required: {
npm error EBADDEVENGINES     name: 'pnpm',
npm error EBADDEVENGINES     version: '10.8.0+sha256.29bf2c5ceaea7991ee82eec15fe7162e0fad816d0c4a6b35a16c01d39274bf69'
npm error EBADDEVENGINES   }
npm error EBADDEVENGINES }
npm error A complete log of this run can be found in: /vercel/.npm/_logs/2025-04-24T20_40_20_242Z-debug-0.log
Error: Command "turbo build" exited with 1

avivkeller · 2025-04-24T20:53:02Z

Ugh! What more does Vercel want from us?! I'm going to try to turbo build and see.

avivkeller · 2025-04-24T20:57:59Z

Yep, Vercel is definetely going to throw a temper tantrum. I think we need to suck it up and enable pnpm on it right before merge.

bmuenzenmeyer · 2025-04-25T11:24:39Z

can we add devEngines as a fast-follow?

AugustinMauroy · 2025-04-25T12:08:01Z

I've just had a look, and I didn't see a link/explanation to get the right version of pnpm.

avivkeller · 2025-04-25T13:44:08Z

can we add devEngines as a fast-follow?

It's more than that to satisfy Vercel. IIUC, Vercel does the following (among other things):

cd apps/site
npm i
npx turbo build

You'll see that the steps will fail for various reasons. After doing some (failed) testing, IMHO It's easier to switch Vercel to pnpm, at the risk of a few broken PRs, than to rework this PR to satisfy npm.

I've just had a look, and I didn't see a link/explanation to get the right version of pnpm.

What do you mean? The version of pnpm we use is 10.x.

npm use cases

@bmuenzenmeyer I don't understand what this task is? It's really the only thing left to complete (besides Vercel deployments).

bmuenzenmeyer · 2025-04-25T14:14:22Z

@bmuenzenmeyer I don't understand what this task is? It's really the only thing left to complete (besides Vercel deployments).

I want to explore what the experience is when someone casually tries to use npm, per #5334 (comment) - I now know that devEngines will likely stop them in their tracks. so... that request of @AugustinMauroy's might be in direct conflict with the devEngines vote

avivkeller · 2025-04-25T16:28:28Z

IMO we should prioritize the vote rather than the request. On that note, since everything is working (well, except Vercel), I've marked this Ready for Review.

avivkeller · 2025-04-25T16:31:35Z

.nvmrc

@@ -1 +1 @@
-v22
+v22.13.0


Can we not just use v22?

packages/ui-components/package.json

MattIPv4

Why have a bunch of @/ shorthand imports been changed to relative imports?

.github/workflows/build.yml

.github/workflows/chromatic.yml

.github/workflows/lint-and-tests.yml

.github/workflows/translations-sync.yml

README.md

MattIPv4 · 2025-04-25T16:38:02Z

apps/site/package.json

+    "cross-env": "7.0.3",
+    "@types/node": "22.14.0",
+    "@types/react": "^19.1.0"


These should be alphabetical?

MattIPv4 · 2025-04-25T16:38:28Z

apps/site/package.json

-    "vfile-matter": "~5.0.1"
+    "vfile-matter": "~5.0.1",
+    "cross-env": "7.0.3",
+    "@types/node": "22.14.0",


This doesn't match the minor version in .nvmrc (afaik @types/node should match on major/minor, but patch does not match)

MattIPv4 · 2025-04-25T16:39:44Z

package.json

-    "@types/node": "22.14.0",
-    "@types/react": "^19.1.0",
-    "@types/react-dom": "^19.1.1",
+    "cross-env": "7.0.3",


Why is this pinned to an exact version, and present here as well as in the site's dependencies?

It's present b/c we use it in the scripts section of the package.json. In pnpm (IIUC), you need to declare dependencies in each package.json that they are used.

Ah okay, that's news to me if that's the case -- can we double-check it is? If it is, can we have it reference the parent package's version for it?

And, I'm not sure that was an answer to why it is pinned to a specific version?

MattIPv4 · 2025-04-25T16:40:52Z

packages/ui-components/package.json

    "eslint-plugin-react": "~7.37.4",
    "eslint-plugin-storybook": "~0.12.0",
    "global-jsdom": "^26.0.0",
+    "postcss-loader": "~8.1.1",
+    "react": "19.1.0",


Confirming if this is intentionally pinned, when the types for it aren't?

We should use peer dependencies for these cases.

Check out other applications (https://github.com/dubinc/dub/blob/93c76aaf304a10fcf914c1c4dc344f6011e2bc6b/packages/ui/package.json#L35)

MattIPv4 · 2025-04-25T16:42:58Z

On my --frozen-lockfile comments, happy to have dissenting opinions there -- https://pnpm.io/settings#preferfrozenlockfile pnpm does default to respecting it exactly if it's valid, so it should be fine to not pass the arg, but I tend to like being explicit about it?

avivkeller · 2025-04-25T16:46:24Z

I mean, SGTM, we can always change it if needed.

bjohansebas · 2025-04-25T23:27:01Z

apps/site/hooks/react-client/__tests__/useClientContext.test.jsx

-import useClientContext from '@/hooks/react-client/useClientContext';
-import { MatterContext } from '@/providers/matterProvider';
+import useClientContext from '../useClientContext';
+import { MatterContext } from '../../../providers/matterProvider';


Why can’t "@/" be used anymore? pnpm should not affect the path aliases.

bjohansebas · 2025-04-25T23:30:44Z

pnpm-workspace.yaml

+onlyBuiltDependencies:
+  - '@swc/core'
+  - '@vercel/speed-insights'
+  - esbuild
+  - sharp


A comment on why it's necessary would be great.

bjohansebas · 2025-04-25T23:31:50Z

apps/site/package.json

+    "@opentelemetry/api-logs": "~0.200.0",
+    "@opentelemetry/instrumentation": "~0.200.0",
+    "@opentelemetry/resources": "~1.30.1",
+    "@opentelemetry/sdk-logs": "~0.200.0",


Why do we have to add all those new dependencies?

Co-authored-by: Matt Cowley <me@mattcowley.co.uk> Signed-off-by: Aviv Keller <me@aviv.sh>

ovflowd · 2025-04-26T22:48:41Z

npm error code EUNSUPPORTEDPROTOCOL
npm error Unsupported URL Type "workspace:": workspace:*
npm error A complete log of this run can be found in: /vercel/.npm/_logs/2025-04-25T23_42_55_527Z-debug-0.log
Error: Command "npm install --omit=dev --include-workspace-root" exited with 1

MattIPv4 · 2025-04-26T22:51:29Z

Is that from Vercel? That makes sense, the install/build commands for the entire project will need to be changed IIRC. So, I imagine we'll want to flip them for a second to pnpm, deploy this branch, and then flip them back to npm to allow main and other PRs to work.

MattIPv4 · 2025-04-26T22:53:12Z

Ah, looks like we can add vercel.json to override it for this specific branch: https://vercel.com/docs/package-managers#deployment-override

vercel bot had a problem deploying to Preview April 17, 2025 21:42 Failure

vercel bot had a problem deploying to Preview April 18, 2025 02:58 Failure

bmuenzenmeyer changed the title ~~initial conversion~~ pnpm Apr 18, 2025

vercel bot had a problem deploying to Preview April 18, 2025 15:09 Failure

vercel bot had a problem deploying to Preview April 18, 2025 15:13 Failure

vercel bot had a problem deploying to Preview April 18, 2025 15:32 Failure

bmuenzenmeyer added the github_actions:pull-request Trigger Pull Request Checks label Apr 18, 2025

bmuenzenmeyer had a problem deploying to Storybook April 18, 2025 15:49 — with GitHub Actions Failure

github-actions bot removed the github_actions:pull-request Trigger Pull Request Checks label Apr 18, 2025

vercel bot had a problem deploying to Preview April 18, 2025 15:51 Failure

vercel bot had a problem deploying to Preview April 18, 2025 16:04 Failure

vercel bot had a problem deploying to Preview April 18, 2025 19:59 Failure

vercel bot had a problem deploying to Preview April 18, 2025 22:21 Failure

vercel bot had a problem deploying to Preview April 19, 2025 04:00 Failure

vercel bot had a problem deploying to Preview April 19, 2025 04:15 Failure

AugustinMauroy reviewed Apr 19, 2025

View reviewed changes

.github/workflows/lint-and-tests.yml Show resolved Hide resolved

vercel bot had a problem deploying to Preview April 19, 2025 12:08 Failure

vercel bot had a problem deploying to Preview April 19, 2025 21:44 Failure

vercel bot had a problem deploying to Preview April 19, 2025 22:06 Failure

vercel bot had a problem deploying to Preview April 19, 2025 22:13 Failure

vercel bot had a problem deploying to Preview April 19, 2025 22:30 Failure

vercel bot had a problem deploying to Preview April 20, 2025 14:34 Failure

vercel bot had a problem deploying to Preview April 20, 2025 15:23 Failure

avivkeller force-pushed the pnpm branch from 9559380 to ee826b7 Compare April 20, 2025 15:24

vercel bot had a problem deploying to Preview April 20, 2025 15:24 Failure

avivkeller deployed to Storybook April 20, 2025 16:35 — with GitHub Actions View deployment

vercel bot had a problem deploying to Preview April 24, 2025 20:36 Failure

vercel bot had a problem deploying to Preview April 24, 2025 20:40 Failure

vercel bot had a problem deploying to Preview April 24, 2025 20:51 Failure

vercel bot had a problem deploying to Preview April 24, 2025 20:55 Failure

avivkeller force-pushed the pnpm branch from dadd5e3 to 5d0e707 Compare April 24, 2025 20:58

vercel bot had a problem deploying to Preview April 24, 2025 20:58 Failure

avivkeller marked this pull request as ready for review April 25, 2025 16:28

avivkeller requested review from a team as code owners April 25, 2025 16:28

avivkeller approved these changes Apr 25, 2025

View reviewed changes

MattIPv4 reviewed Apr 25, 2025

View reviewed changes

bjohansebas reviewed Apr 25, 2025

View reviewed changes

Clarity suggestions from @MattIPv4 and @avivkeller

c03ce33

Co-authored-by: Matt Cowley <me@mattcowley.co.uk> Signed-off-by: Aviv Keller <me@aviv.sh>

vercel bot had a problem deploying to Preview April 25, 2025 23:43 Failure

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(infra): adopt `pnpm` #7662

feat(infra): adopt `pnpm` #7662

bmuenzenmeyer commented Apr 17, 2025 •

edited by avivkeller

Loading

vercel bot commented Apr 17, 2025 •

edited

Loading

bmuenzenmeyer commented Apr 18, 2025

avivkeller commented Apr 18, 2025

avivkeller commented Apr 24, 2025

ovflowd commented Apr 24, 2025

avivkeller commented Apr 24, 2025 •

edited

Loading

avivkeller commented Apr 24, 2025 •

edited

Loading

bmuenzenmeyer commented Apr 25, 2025

AugustinMauroy commented Apr 25, 2025

avivkeller commented Apr 25, 2025 •

edited

Loading

bmuenzenmeyer commented Apr 25, 2025

avivkeller commented Apr 25, 2025 •

edited

Loading

avivkeller Apr 25, 2025

MattIPv4 left a comment

MattIPv4 Apr 25, 2025

bjohansebas Apr 25, 2025

MattIPv4 Apr 25, 2025

MattIPv4 Apr 25, 2025

avivkeller Apr 25, 2025

MattIPv4 Apr 26, 2025

MattIPv4 Apr 25, 2025

bjohansebas Apr 25, 2025

MattIPv4 commented Apr 25, 2025

avivkeller commented Apr 25, 2025

bjohansebas Apr 25, 2025

bjohansebas Apr 25, 2025

bjohansebas Apr 25, 2025

ovflowd commented Apr 26, 2025

MattIPv4 commented Apr 26, 2025

MattIPv4 commented Apr 26, 2025

		@@ -1 +1 @@
		v22
		v22.13.0

feat(infra): adopt pnpm #7662

Are you sure you want to change the base?

feat(infra): adopt pnpm #7662

Conversation

bmuenzenmeyer commented Apr 17, 2025 • edited by avivkeller Loading

Tasks from Vote

vercel bot commented Apr 17, 2025 • edited Loading

bmuenzenmeyer commented Apr 18, 2025

avivkeller commented Apr 18, 2025

avivkeller commented Apr 24, 2025

ovflowd commented Apr 24, 2025

avivkeller commented Apr 24, 2025 • edited Loading

avivkeller commented Apr 24, 2025 • edited Loading

bmuenzenmeyer commented Apr 25, 2025

AugustinMauroy commented Apr 25, 2025

avivkeller commented Apr 25, 2025 • edited Loading

bmuenzenmeyer commented Apr 25, 2025

avivkeller commented Apr 25, 2025 • edited Loading

Choose a reason for hiding this comment

MattIPv4 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MattIPv4 commented Apr 25, 2025

avivkeller commented Apr 25, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ovflowd commented Apr 26, 2025

MattIPv4 commented Apr 26, 2025

MattIPv4 commented Apr 26, 2025

feat(infra): adopt `pnpm` #7662

feat(infra): adopt `pnpm` #7662

bmuenzenmeyer commented Apr 17, 2025 •

edited by avivkeller

Loading

vercel bot commented Apr 17, 2025 •

edited

Loading

avivkeller commented Apr 24, 2025 •

edited

Loading

avivkeller commented Apr 24, 2025 •

edited

Loading

avivkeller commented Apr 25, 2025 •

edited

Loading

avivkeller commented Apr 25, 2025 •

edited

Loading