Skip to content

docs(CONTRIBUTING): replace 'npm run test' and 'npx nx' commands with 'pnpm' equivalents - #11095

Merged
sukvvon merged 3 commits into
TanStack:mainfrom
Antoliny0919:refactor-npm-to-pnpm
Aug 2, 2026
Merged

docs(CONTRIBUTING): replace 'npm run test' and 'npx nx' commands with 'pnpm' equivalents#11095
sukvvon merged 3 commits into
TanStack:mainfrom
Antoliny0919:refactor-npm-to-pnpm

Conversation

@Antoliny0919

@Antoliny0919 Antoliny0919 commented Jul 21, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Contributor

🎯 Changes

The project currently uses pnpm as its package manager. While using npm isn't an issue, I think it would be more consistent to update the contribution guide to use pnpm throughout as well.

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested this code locally with pnpm run test:pr.

🚀 Release Impact

  • This change affects published code, and I have generated a changeset.
  • This change is docs/CI/dev-only (no release).

Summary by CodeRabbit

  • Documentation
    • Updated testing instructions to use pnpm commands.
    • Revised guidance for running all tests and running tests for specific packages.

@coderabbitai

coderabbitai Bot commented Jul 21, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

Updated CONTRIBUTING.md to use pnpm for running all tests and package-specific library tests.

Changes

Test command documentation

Layer / File(s) Summary
Update test command instructions
CONTRIBUTING.md		 The contributor guide now uses pnpm run test and pnpm nx run ...:test:lib commands.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

  • TanStack/query#11066: Updates overlapping CONTRIBUTING.md guidance for running commands with pnpm.

Suggested reviewers: sukvvon

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly identifies the documentation file and the replacement of npm and npx commands with pnpm equivalents.
Description check ✅ Passed The description includes the required changes, checklist, and release impact sections, with relevant items completed.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@nx-cloud

nx-cloud Bot commented Aug 2, 2026 •
edited
Loading

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit dde66b4

Command Status Duration Result
nx run-many --target=build --exclude=examples/*... ✅ Succeeded 1m 34s View ↗
nx affected --targets=test:sherif,test:knip,tes... ✅ Succeeded 3m 9s View ↗

☁️ Nx Cloud last updated this comment at 2026-08-02 06:50:52 UTC

@sukvvon sukvvon changed the title docs(CONTRIBUTING): replace 'npm run test' and 'npx nx' command with 'pnpm' equivalents docs(CONTRIBUTING): replace 'npm run test' and 'npx nx' commands with 'pnpm' equivalents Aug 2, 2026
@pkg-pr-new

pkg-pr-new Bot commented Aug 2, 2026

Copy link
Copy Markdown
More templates

@tanstack/angular-query-experimental

npm i https://pkg.pr.new/@tanstack/angular-query-experimental@11095

@tanstack/eslint-plugin-query

npm i https://pkg.pr.new/@tanstack/eslint-plugin-query@11095

@tanstack/lit-query

npm i https://pkg.pr.new/@tanstack/lit-query@11095

@tanstack/preact-query

npm i https://pkg.pr.new/@tanstack/preact-query@11095

@tanstack/preact-query-devtools

npm i https://pkg.pr.new/@tanstack/preact-query-devtools@11095

@tanstack/preact-query-persist-client

npm i https://pkg.pr.new/@tanstack/preact-query-persist-client@11095

@tanstack/query-async-storage-persister

npm i https://pkg.pr.new/@tanstack/query-async-storage-persister@11095

@tanstack/query-broadcast-client-experimental

npm i https://pkg.pr.new/@tanstack/query-broadcast-client-experimental@11095

@tanstack/query-core

npm i https://pkg.pr.new/@tanstack/query-core@11095

@tanstack/query-devtools

npm i https://pkg.pr.new/@tanstack/query-devtools@11095

@tanstack/query-persist-client-core

npm i https://pkg.pr.new/@tanstack/query-persist-client-core@11095

@tanstack/query-sync-storage-persister

npm i https://pkg.pr.new/@tanstack/query-sync-storage-persister@11095

@tanstack/react-query

npm i https://pkg.pr.new/@tanstack/react-query@11095

@tanstack/react-query-devtools

npm i https://pkg.pr.new/@tanstack/react-query-devtools@11095

@tanstack/react-query-next-experimental

npm i https://pkg.pr.new/@tanstack/react-query-next-experimental@11095

@tanstack/react-query-persist-client

npm i https://pkg.pr.new/@tanstack/react-query-persist-client@11095

@tanstack/solid-query

npm i https://pkg.pr.new/@tanstack/solid-query@11095

@tanstack/solid-query-devtools

npm i https://pkg.pr.new/@tanstack/solid-query-devtools@11095

@tanstack/solid-query-persist-client

npm i https://pkg.pr.new/@tanstack/solid-query-persist-client@11095

@tanstack/svelte-query

npm i https://pkg.pr.new/@tanstack/svelte-query@11095

@tanstack/svelte-query-devtools

npm i https://pkg.pr.new/@tanstack/svelte-query-devtools@11095

@tanstack/svelte-query-persist-client

npm i https://pkg.pr.new/@tanstack/svelte-query-persist-client@11095

@tanstack/vue-query

npm i https://pkg.pr.new/@tanstack/vue-query@11095

@tanstack/vue-query-devtools

npm i https://pkg.pr.new/@tanstack/vue-query-devtools@11095

commit: dde66b4

@sukvvon
sukvvon merged commit 6efc619 into TanStack:main Aug 2, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sukvvon sukvvon sukvvon approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Antoliny0919 @sukvvon