[v13] Use pnpm for package management

[ryanwilsonperkin]

Edited by @jesstelford: Because speed.

[alex-page]

If we are going to use pnpm workspaces we should remove all the other stuff like package.json workspaces and turborepo.

[ryanwilsonperkin]

A whole bunch of these commits could be shipped independently if we'd like to reduce the size of this PR. They're fixing issues that only become apparent after pnpm's change to no longer hoist transitive & sub-package dependencies, and would work without pnpm

[sam-b-rose]

Tested and all tasks and workflow appear to be functioning properly 👍

Can we also remove the workspaces key with packages and nohoist`?

[jesstelford]

Approved! With one ask to revert some of the code formatting changes (just to keep the diff size down).

[jesstelford]

Bunch of these appear to be prettier-related changes.

Do you mind if we revert these and bring them in a separate PR (they're functionally equivalent)?

[ryanwilsonperkin]

Works for me!

[ryanwilsonperkin]

Extracted here: #11824

[ryanwilsonperkin]

Interesting, CI fails there: https://github.com/Shopify/polaris/actions/runs/8528174905/job/23361209192?pr=11824
So it would seem that we're ending up with a different version of a key package (TypeScript? Eslint?) when linting one of these packages if using yarn instead of pnpm

[jesstelford]

Ah damn, in that case, leave the changes in this PR. Sorry for the extra work there!

[jesstelford]

I hacked together a script (below) to try compare the build output with pnpm expecting zero changes (it's the package manager that's changed, not the packages themselves), but... There's quite a bit of difference 😓

Some of it seems to be slight differences in however the build tool has generated the final JS with extra parens here and there, but then there's other parts which appear to change the exports of files, etc 😱

Give it a run yourself and see if you're noticing similar differences:

Put this in the root of the Polaris repo as script.sh, allow it to be executed with chmod a+x ./script.sh, then run it ./script.sh

#!/usr/bin/env bash
declare -a build_folders=(
  "polaris-for-vscode/dist/"
  "polaris-icons/dist/"
  "polaris-migrator/dist/"
  "polaris-react/build/"
  "polaris-tokens/dist/"
  "polaris.shopify.com/.next/"
  "polaris.shopify.com/public/playroom/"
  "polaris.shopify.com/public/og-images/"
  "polaris.shopify.com/public/og-images/"
)

git fetch
source ~/.nvm/nvm.sh
MAIN_COMMIT=`git merge-base origin/pnpm origin/main`

# # Get a clean repo at the latest shared ancestor that's using yarn
git worktree add ../polaris-main $MAIN_COMMIT
cd ../polaris-main
nvm use
yarn
yarn build
for i in "${build_folders[@]}"
do
  mkdir -p "../polaris-build/main/""$i"
  cp -R "$i" "../polaris-build/main/""$i"
done

cd -

# Cleanup
git worktree remove -f ../polaris-main

git worktree add ../polaris-pnpm origin/pnpm
cd ../polaris-pnpm
nvm use
pnpm install
pnpm build
for i in "${build_folders[@]}"
do
  mkdir -p "../polaris-build/pnpm/""$i"
  cp -R "$i" "../polaris-build/pnpm/""$i"
done

cd -
# Cleanup
git worktree remove -f ../polaris-pnpm

echo "Now run: git diff --no-index ../polaris-build/main ../polaris-build/pnpm"

[ryanwilsonperkin]

I hacked together a script (below) to try compare the build output with pnpm expecting zero changes (it's the package manager that's changed, not the packages themselves), but... There's quite a bit of difference 😓

Some of it seems to be slight differences in however the build tool has generated the final JS with extra parens here and there, but then there's other parts which appear to change the exports of files, etc 😱

Thanks for putting this together @jesstelford ! It looks to me like a lot of changes to the nextJS compiled output (shouldn't be a big deal for our purposes) and also some changes to the way the dist files get build & minified. This suggests to me that perhaps the version of Rollup or one of its sub-dependencies has changed. Maybe a version that one of the packages depends on was previously improperly hoisted?

It'd be great to try testing the bundles in some of our consumers like Shopify/Web and see if they result in any differences (they shouldn't)

[aaronccasanova]

/snapit

[ryanwilsonperkin]

@sam-b-rose after removing the .workspaces reference from package.json the linter is failing because .eslintrc.js was relying on it to find package directories:

const packages = require('./package.json').workspaces.packages;

If we want a 1-1 replacement, I can add a dependency on js-yaml to the workspace root so that we can read the pnpm-workspace.yaml file to retrieve this information. Thoughts?

[aaronccasanova]

@ryanwilsonperkin +1 to continuing with pnpm-workspace.yaml as the source of truth and introducing js-yaml for feature parity in .eslintrc.js

[aaronccasanova]

/snapit

[jesstelford]

@ryanwilsonperkin We're prepping for a major release of Polaris in the next week or so (to update the minimum node version) - how do you feel about this change being merged as part of the major release?

I'm happy with the change, but given the changes seen in that script I ran, I wanted to just play it safe and push it out as a major in case something has changed.

☝️ Moderate opinion, weakly held

[alex-page]

@jesstelford I like that idea as it's a pretty significant change for developers contributing to Polaris.

[jesstelford]

Ok, in that case I'll mark this PR as Draft until we're ready for the v13 release.

@ryanwilsonperkin are you ok if myself & @aaronccasanova take over this PR from here? We'll shepherd it into the wild ASAP 🎉

[ryanwilsonperkin]

Sounds good to me! Thanks @jesstelford

[jesstelford]

Heads up; I've rebased this on top of the node-20 branch (PR: #11844) so we can ensure they're playing together nicely, and we can merge this PR immediately after node-20 is merged 👍

[aaronccasanova]

Suggested change

	"new-migration": "pnpm workspace @shopify/polaris-migrator generate"
	"new-migration": "pnpm --filter @shopify/polaris-migrator generate"

[jesstelford]

yarn used to hoist everything to the root node_modules, but pnpm doesn't hoist like that, so we only need to go up to the polaris-react/node_modules to find the dependency.

[ryanwilsonperkin]

🚀🚀🚀