-
-
Notifications
You must be signed in to change notification settings - Fork 2.8k
chore: migrate to pnpm #11248
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
chore: migrate to pnpm #11248
Conversation
refactor: removed .yarn folder fix: changed overrides approach feat: changed references
Replacing variables
Migrate scripts to pnpm and replaced yarn reference
Replaced yarn reference with pnpm
Added rule schema types
Fixed types
Launching app pnpm
Resolved problems with babel types
docs: updated comments to reflect pnpm usage instead of yarn
# Conflicts: # package.json # packages/eslint-plugin/package.json # packages/type-utils/package.json # packages/website/package.json # yarn.lock
ebfcbff
to
09b0f85
Compare
fix: resolved conflicts fix: corrected the version
09b0f85
to
5de32f8
Compare
# Conflicts: # CONTRIBUTORS.md # packages/eslint-plugin/package.json # packages/type-utils/package.json # tools/scripts/generate-contributors.mts # yarn.lock
# Conflicts: # packages/eslint-plugin/package.json # packages/type-utils/package.json # yarn.lock
# Conflicts: # knip.ts # nx.json # packages/ast-spec/package.json # packages/eslint-plugin-internal/package.json # packages/eslint-plugin/package.json # packages/integration-tests/package.json # packages/parser/package.json # packages/rule-schema-to-typescript-types/package.json # packages/rule-tester/package.json # packages/scope-manager/package.json # packages/type-utils/package.json # packages/types/package.json # packages/typescript-eslint/package.json # packages/typescript-estree/package.json # packages/utils/package.json # packages/visitor-keys/package.json # yarn.lock
Hi @JoshuaKGoldberg, @JamesHenry, @bradzacher, @kirkwaiblinger, and the rest of the team! 👋 First of all, thank you for all the work you do maintaining this project — it’s a huge help to the community, and I really appreciate the time and care you put into it. I was just wondering if there’s any chance a maintainer could take a look at this PR. I understand you're all busy, but since it hasn’t received a review from a maintainer yet, I’d be happy, along with @Jester175, to revise or adjust anything needed once there’s some feedback. Thanks again! |
# Conflicts: # tools/scripts/generate-sponsors.mts # yarn.lock
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this @xaos7991!
Please kindly take a look at all the inline comments.
Additionally:
-
The changes to the dependency and task graphs of the workspace through this change of package manager are unexpected and make me nervous that scope creep has occurred. Can we achieve this change of package manager without changing the relationships in the repo please? If they need to be changed for correctness let's please discuss and potentially address in a follow up (or pre-requisite PR)
-
I am not familiar enough with
-w exec
so I will need to check out the PR to play with that in all the subpackages, which I will do when other tasks have been addressed. -
I will push a commit to change the release setup once all other TODOs are addressed and the PR is green again
@@ -30,50 +30,24 @@ runs: | |||
working-directory: ${{ inputs.working-directory }} | |||
run: echo ${{ github.ref }} | |||
|
|||
- uses: actions/checkout@v4 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why did you add another checkout here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I probably didn't notice that extra checkout. I've removed it now based on your suggestion.
@@ -129,7 +129,7 @@ jobs: | |||
uses: ./.github/actions/prepare-build | |||
|
|||
- name: Run Check | |||
run: yarn ${{ matrix.lint-task }} | |||
run: pnpm ${{ matrix.lint-task }} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing run
for consistency with your other ones
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi! 👋
Thanks a lot for the review🙌
Just a quick note on this:
- name: Run Check
run: pnpm ${{ matrix.lint-task }}
You're right that for consistency with the other commands, it might make sense to use run: pnpm run
.... However, in our case, we have one task in the matrix (knip) that directly runs a binary (i.e. knip) and doesn't currently have a corresponding script entry in package.json.
To use pnpm run knip, we'd need to define a script like "knip": "knip"
in package.json. We chose to call the binary directly here to avoid extra script declarations.
Please correct me if I’m mistaken, but that was the reasoning behind the current setup. Happy to align if you think we should change it! 😊
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
pnpm needs to be installed into this workflow for it to continue to work, it should be done without running an install.
- uses: pnpm/action-setup@v4
if: ${{ steps.nrwl-workspace-package-check.outputs.was-changed == 'true' }}
name: Install pnpm
with:
run_install: false
You can cross-reference with my other repo which already uses pnpm here: https://github.com/angular-eslint/angular-eslint/blob/main/.github/workflows/nx-migrate.yml
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
.github/workflows/nx-migrate.yml
Outdated
|
||
YARN_ENABLE_IMMUTABLE_INSTALLS=false yarn install | ||
pnpm install |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The install should allow modifications:
# We need to expect lock file changes to be applicable
pnpm install --ignore-scripts --frozen-lockfile=false
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
.github/workflows/nx-migrate.yml
Outdated
|
||
# Sometimes Nx can require config formatting changes after a migrate command | ||
YARN_ENABLE_IMMUTABLE_INSTALLS=false yarn install | ||
yarn nx format | ||
pnpm install |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same again
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
@@ -68,9 +68,6 @@ | |||
{ | |||
"runtime": "node -v" | |||
}, | |||
{ | |||
"runtime": "yarn -v" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Replace with pnpm -v
, don't remove
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
@@ -1,5 +1,6 @@ | |||
{ | |||
"devDependencies": { | |||
"eslint": "8.57.0" | |||
"eslint": "8.57.0", | |||
"@eslint/js": "latest" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a different major version to the eslint package, this feels wrong...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
@@ -35,7 +35,7 @@ export function eslintIntegrationTest( | |||
let stderr = ''; | |||
try { | |||
await execFile( | |||
'yarn', | |||
'pnpm', |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing usage of run
for consistency
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
@@ -94,7 +94,7 @@ export function typescriptIntegrationTest( | |||
): void { | |||
integrationTest(testName, testFilename, async testFolder => { | |||
const [result] = await Promise.allSettled([ | |||
execFile('yarn', ['tsc', '--noEmit', '--skipLibCheck', ...tscArgs], { | |||
execFile('pnpm', ['tsc', '--noEmit', '--skipLibCheck', ...tscArgs], { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing usage of run
for consistency
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
@@ -43,12 +43,12 @@ const { projectsVersionData, workspaceVersion } = await releaseVersion({ | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This needs to be redone, you can leave it to me
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you so much!
It would be great if you could take care of that part - totally trust your judgment on it. Let me know if there's anything you'd like me to adjust on my side!
During our work, we discovered that specifying a version like: However, referencing it as a workspace: It seems this package isn't published publicly and is meant to be used internally within the monorepo. Might be worth clarifying to avoid confusion. |
Uh oh! @Jester175, at least one image you shared is missing helpful alt text. Check #11248 (comment) to fix the following violations:
Alt text is an invisible description that helps screen readers describe images to blind or low-vision users. If you are using markdown to display images, add your alt text inside the brackets of the markdown image. Learn more about alt text at Basic writing and formatting syntax: images on GitHub Docs.
|
PR Checklist
Overview