Use pnpm + workspaces #3382

nickgros · 2023-01-16T01:49:10Z

Reasons for making this change

pnpm + workspaces + Lerna deduplicates dependencies between packages. Only one copy of a dependency version will be installed across the entire repo. Only one lockfile is needed for the entire project. This should greatly reduce the amount of time needed to install dependencies, and improve overall developer experience.

Checklist

I'm updating documentation
- I've checked the rendering of the Markdown text I've added
I'm adding or updating code
- I've added and/or updated tests. I've run npm run test:update to update snapshots, if needed.
- I've updated docs if needed
- I've updated the changelog with a description of the PR
I'm adding a new feature
- I've updated the playground with an example use of the feature

nickgros · 2023-01-16T01:51:43Z

package.json

+  "resolutions": {
+    "@types/react": "^17.0.39"
+  },


TODO: I think I can remove this and just have this in utils/package.json

nickgros · 2023-01-16T01:53:02Z

packages/chakra-ui/src/AltDateWidget/AltDateWidget.tsx

@@ -129,7 +129,7 @@ function AltDateWidget<

  return (
    <Box>
-      <Box display="flex" flexWrap="wrap" alignItems="center" justify="center">
+      <Flex flexWrap="wrap" alignItems="center">


I think I happened to pull in a more recent version of chakra-ui and discovered justify is not a valid prop on Box. We can use the Flex component, instead. I think we actually want to keep this left-aligned, though, so I ended up removing justify="center" anyways.

nickgros · 2023-01-16T01:54:16Z

packages/playground/vite.config.ts

+      "@mui/styles": path.resolve("../../node_modules", "@mui/styles"),
      "@material-ui/styles": path.resolve(
-        "./node_modules",
+        "../../node_modules",
        "@material-ui/styles"
      ),
-      "@emotion/react": path.resolve("./node_modules/@emotion/react"),
-      "@emotion/styled": path.resolve("./node_modules/@emotion/styled"),
+      "@emotion/react": path.resolve("../../node_modules/@emotion/react"),
+      "@emotion/styled": path.resolve("../../node_modules/@emotion/styled"),


Since the dependencies are now deduplicated and stored in the root node_modules folder, we need to update these references.

nickgros · 2023-01-16T01:55:06Z

packages/utils/package.json

+  "resolutions": {
+    "@types/react": "^17.0.48"
+  },


Some dependency is pulling in @types/react@* which causes us to pull an incompatible version of @types/react, so let's force using v17.

nickgros · 2023-01-16T01:55:40Z

packages/validator-ajv8/package.json

+  "resolutions": {
+    "ajv": "^8.11.0"
+  },


TODO: I think I added this trying to fix the old playground issue, and can remove this.

cdaringe · 2023-01-18T03:38:03Z

strong encouragement to check out pnpm workspaces. pnpm workspaces, based on my personal research, trump yarn workspaces by features/stability/performance. my yarn workspace experience is out-of-date by probably 8 months, but pnpm experience is fresh, and it's delightful.

bollwyvl · 2023-01-23T15:08:17Z

👍 to yarn and (modern) lerna. I have no experience with pnpm, but also have very few complaints about the yarn 1.x experience, while 2.x+ seems to have gone wandering in the woods a bit.

One can go a little beyond the built-in yarn deduplication with yarn-deduplicate, which can squeeze a few more things out (especially when paired with a few tactical resolutions).

Also, on the typescript side: having a metapackage which contains references to all the other packages allows for having a single, incremental tsc -b entrypoint, which makes a big difference in both improving performance of type-checking at scale, and complexity.

nickgros · 2023-01-27T17:43:31Z

@cdaringe @bollwyvl thanks for the perspectives! While I have more experience with yarn, pnpm ended up being a breeze to configure comparatively, so we'll go with pnpm for now.

If incremental builds end up being pretty easy to switch to, then I'll include that in this change, as well.

ahkhanjani · 2023-03-08T05:30:18Z

Why not use Nx for distributed caching? Has the same benefits with way better tooling and will reduce lint, test and build time to potentially under 10 seconds

nickgros · 2023-03-13T16:38:45Z

Why not use Nx for distributed caching? Has the same benefits with way better tooling and will reduce lint, test and build time to potentially under 10 seconds

I don't think that this change would preclude adding Nx cloud caching, which has no impact on dependency install time anyways.

ahkhanjani · 2023-03-13T20:31:43Z

I don't think that this change would preclude adding Nx cloud caching, which has no impact on dependency install time anyways.

@nickgros But why use pnpm workspaces over Nx itself?

cdaringe · 2023-03-13T20:44:01Z

As a nx user and a pnpm user and a pnpm+nx user, there are many reasons why would or wouldnt. Reasons to not would be high maintenance costs, poor debugging story, high noise:signal ratio of boilerplate, stringly typed references to workspace/project entities. There are good reasons as well (affected). Not sure nx is worth the effort for a project of this size. Were i the maintainer, Id opt out until something demanded it

ahkhanjani · 2023-03-25T09:40:04Z

As a nx user and a pnpm user and a pnpm+nx user, there are many reasons why would or wouldnt. Reasons to not would be high maintenance costs, poor debugging story, high noise:signal ratio of boilerplate, stringly typed references to workspace/project entities. There are good reasons as well (affected). Not sure nx is worth the effort for a project of this size. Were i the maintainer, Id opt out until something demanded it

@cdaringe I think having internal libraries (validator-ajv6/8, utils, etc.) as a regular import and not a package, and most importantly "affected" will make the local and deployment process a hundred times faster at the very least. running all the tests and linting and then building every package for the change of only one package is something worth considering in my opinion.

Best regards

ahkhanjani · 2023-04-08T10:53:20Z

Any updates on this?

nickgros · 2023-04-10T17:45:23Z

@ahkhanjani I keep getting errors in CI that are hard to reproduce locally. Haven't had much time to try to find the root cause.

ahkhanjani · 2023-04-10T20:19:07Z

@nickgros I will try to do the same thing and fix some issues. The problems seem to be poor typing issues in some places

- Replace npm with pnpm - Upgrade dependencies and include all directly used dependencies in package.json files - Update chakra-ui AltDateWidget to use Flex instead of Box with flex property (fixes build issue) - Update snapshots - Update CONTRIBUTING to reference pnpm - Update CHANGELOG

nickgros commented Jan 16, 2023

View reviewed changes

nickgros force-pushed the yarn-workspaces branch from 4f60196 to c45cf3f Compare January 27, 2023 17:43

nickgros changed the title ~~Use yarn workspaces~~ Use pnpm + workspaces Jan 27, 2023

nickgros force-pushed the yarn-workspaces branch 4 times, most recently from 0d3ad26 to 10e40f7 Compare January 27, 2023 18:27

nickgros force-pushed the yarn-workspaces branch from fd1e921 to 075b67c Compare March 7, 2023 01:05

nickgros force-pushed the yarn-workspaces branch from fda994f to 6a539ce Compare March 25, 2023 14:12

ahkhanjani mentioned this pull request Apr 10, 2023

Use PNPM Workspace #3592

Closed

8 tasks

nickgros force-pushed the yarn-workspaces branch from 6a539ce to abde1bb Compare June 11, 2023 18:38

zxbodya mentioned this pull request Jul 13, 2023

Enable npm workspaces #3765

Merged

nickgros closed this Aug 28, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use pnpm + workspaces #3382

Use pnpm + workspaces #3382

nickgros commented Jan 16, 2023 •

edited

Loading

nickgros Jan 16, 2023

nickgros Jan 16, 2023

nickgros Jan 16, 2023

nickgros Jan 16, 2023

nickgros Jan 16, 2023

cdaringe commented Jan 18, 2023

bollwyvl commented Jan 23, 2023

nickgros commented Jan 27, 2023

ahkhanjani commented Mar 8, 2023

nickgros commented Mar 13, 2023

ahkhanjani commented Mar 13, 2023

cdaringe commented Mar 13, 2023 •

edited

Loading

ahkhanjani commented Mar 25, 2023

ahkhanjani commented Apr 8, 2023

nickgros commented Apr 10, 2023

ahkhanjani commented Apr 10, 2023

Use pnpm + workspaces #3382

Use pnpm + workspaces #3382

Conversation

nickgros commented Jan 16, 2023 • edited Loading

Reasons for making this change

Checklist

nickgros Jan 16, 2023

Choose a reason for hiding this comment

nickgros Jan 16, 2023

Choose a reason for hiding this comment

nickgros Jan 16, 2023

Choose a reason for hiding this comment

nickgros Jan 16, 2023

Choose a reason for hiding this comment

nickgros Jan 16, 2023

Choose a reason for hiding this comment

cdaringe commented Jan 18, 2023

bollwyvl commented Jan 23, 2023

nickgros commented Jan 27, 2023

ahkhanjani commented Mar 8, 2023

nickgros commented Mar 13, 2023

ahkhanjani commented Mar 13, 2023

cdaringe commented Mar 13, 2023 • edited Loading

ahkhanjani commented Mar 25, 2023

ahkhanjani commented Apr 8, 2023

nickgros commented Apr 10, 2023

ahkhanjani commented Apr 10, 2023

nickgros commented Jan 16, 2023 •

edited

Loading

cdaringe commented Mar 13, 2023 •

edited

Loading