docs: add missing eslint rules from left navigation
🎯 Changes
Add missing ESLint rules to the left hand side navigation
I noticed the new mutation rule didn't appear there, and when checking saw that a previously added rule was also missing from the list.
✅ Checklist
- [x] I have followed the steps in the Contributing guide.
- [x] I have tested this code locally with
pnpm test:pr.
🚀 Release Impact
- [ ] This change affects published code, and I have generated a changeset.
- [x] This change is docs/CI/dev-only (no release).
Summary by CodeRabbit
-
Documentation
- Updated ESLint guidelines in the docs to include three new items, improving clarity on code standards. Additions include entries such as “No void Query Functions” and “Mutation Property Order.” This helps teams align on consistent linting expectations without altering existing rules or functionality.
⚠️ No Changeset found
Latest commit: 2d1888f66ce65e90434cbd3fc5c8c91ecb1784c7
Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.
This PR includes no changesets
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
Click here to learn what changesets are, and how to add one.
Click here if you're a maintainer who wants to add a changeset to this PR
Walkthrough
Added two ESLint rule entries—"No void Query Functions" and "Mutation Property Order"—to docs/config.json under the ESLint section. No other files or public APIs were changed.
Changes
| Cohort / File(s) | Summary of changes |
|---|---|
ESLint docs configdocs/config.json |
Added two ESLint rule entries: "No void Query Functions" and "Mutation Property Order". |
Estimated code review effort
🎯 1 (Trivial) | ⏱️ ~2 minutes
Possibly related PRs
- TanStack/query#9271 — Adds detailed docs for the mutation-property-order ESLint rule, complementing this PR’s addition to the ESLint list in docs/config.json.
Suggested labels
documentation
Poem
I hop through configs, neat and spry,
Two new rules beneath the sky—
No void queries, order true,
Mutations lined up, tidy too.
Thump-thump! The docs now clearly sing,
Of linted code and everything. 🐇✨
Pre-merge checks and finishing touches
✅ Passed checks (3 passed)
| Check name | Status | Explanation |
|---|---|---|
| Title Check | ✅ Passed | The title succinctly and accurately describes the primary change—adding missing ESLint rules to the documentation’s left-hand navigation—and follows the repository’s conventional commit prefix for docs. It clearly conveys what was added and where, making it straightforward for reviewers and maintainers to understand the focus of the pull request. |
| Description Check | ✅ Passed | The pull request description fully adheres to the repository’s template by providing a clear “🎯 Changes” section that explains the update, a completed “✅ Checklist” confirming contribution guidelines and local testing, and an accurately marked “🚀 Release Impact” section indicating that this is a docs-only change. The inclusion of a screenshot further clarifies the visual change. |
| Docstring Coverage | ✅ Passed | No functions found in the changes. Docstring coverage check skipped. |
✨ Finishing touches
🧪 Generate unit tests
- [ ] Create PR with unit tests
- [ ] Post copyable unit tests in a comment
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.
Comment @coderabbitai help to get the list of available commands and usage tips.
View your CI Pipeline Execution ↗ for commit 2d1888f66ce65e90434cbd3fc5c8c91ecb1784c7
| Command | Status | Duration | Result |
|---|---|---|---|
nx affected --targets=test:sherif,test:knip,tes... |
✅ Succeeded | 1m | View ↗ |
nx run-many --target=build --exclude=examples/*... |
✅ Succeeded | 1s | View ↗ |
☁️ Nx Cloud last updated this comment at 2025-10-01 01:29:36 UTC
More templates
- @tanstack/query-example-angular-auto-refetching
- @tanstack/query-example-angular-basic
- @tanstack/query-example-angular-basic-persister
- @tanstack/query-example-angular-devtools-panel
- @tanstack/query-example-angular-infinite-query-with-max-pages
- @tanstack/query-example-angular-optimistic-updates
- @tanstack/query-example-angular-pagination
- @tanstack/query-example-angular-query-options-from-a-service
- @tanstack/query-example-angular-router
- @tanstack/query-example-angular-rxjs
- @tanstack/query-example-angular-simple
- @tanstack/query-example-solid-astro
- @tanstack/query-example-solid-basic
- @tanstack/query-example-solid-basic-graphql-request
- @tanstack/query-example-solid-default-query-function
- @tanstack/query-example-solid-simple
- @tanstack/query-example-solid-start-streaming
- @tanstack/query-example-react-algolia
- @tanstack/query-example-react-auto-refetching
- @tanstack/query-example-react-basic
- @tanstack/query-example-react-basic-graphql-request
- @tanstack/query-example-chat
- @tanstack/query-example-react-default-query-function
- @tanstack/query-example-react-devtools-panel
- @tanstack/query-example-eslint-legacy
- @tanstack/query-example-react-infinite-query-with-max-pages
- @tanstack/query-example-react-load-more-infinite-scroll
- @tanstack/query-example-react-nextjs
- @tanstack/query-example-react-nextjs-app-prefetching
- @tanstack/query-example-nextjs-suspense-streaming
- @tanstack/query-example-react-offline
- @tanstack/query-example-react-optimistic-updates-cache
- @tanstack/query-example-react-optimistic-updates-ui
- @tanstack/query-example-react-pagination
- @tanstack/query-example-react-playground
- @tanstack/query-example-react-prefetching
- @tanstack/query-example-react-react-native
- @tanstack/query-example-react-router
- @tanstack/query-example-react-rick-morty
- @tanstack/query-example-react-shadow-dom
- @tanstack/query-example-react-simple
- @tanstack/query-example-react-star-wars
- @tanstack/query-example-react-suspense
- @tanstack/query-example-svelte-auto-refetching
- @tanstack/query-example-svelte-basic
- @tanstack/query-example-svelte-load-more-infinite-scroll
- @tanstack/query-example-svelte-optimistic-updates
- @tanstack/query-example-svelte-playground
- @tanstack/query-example-svelte-simple
- @tanstack/query-example-svelte-ssr
- @tanstack/query-example-svelte-star-wars
- @tanstack/query-example-vue-2.6-basic
- @tanstack/query-example-vue-2.7-basic
- @tanstack/query-example-vue-basic
- @tanstack/query-example-vue-dependent-queries
- @tanstack/query-example-vue-nuxt3
- @tanstack/query-example-vue-persister
- @tanstack/query-example-vue-simple
@tanstack/angular-query-experimental
npm i https://pkg.pr.new/@tanstack/angular-query-experimental@9719
@tanstack/eslint-plugin-query
npm i https://pkg.pr.new/@tanstack/eslint-plugin-query@9719
@tanstack/query-async-storage-persister
npm i https://pkg.pr.new/@tanstack/query-async-storage-persister@9719
@tanstack/query-broadcast-client-experimental
npm i https://pkg.pr.new/@tanstack/query-broadcast-client-experimental@9719
@tanstack/query-core
npm i https://pkg.pr.new/@tanstack/query-core@9719
@tanstack/query-devtools
npm i https://pkg.pr.new/@tanstack/query-devtools@9719
@tanstack/query-persist-client-core
npm i https://pkg.pr.new/@tanstack/query-persist-client-core@9719
@tanstack/query-sync-storage-persister
npm i https://pkg.pr.new/@tanstack/query-sync-storage-persister@9719
@tanstack/react-query
npm i https://pkg.pr.new/@tanstack/react-query@9719
@tanstack/react-query-devtools
npm i https://pkg.pr.new/@tanstack/react-query-devtools@9719
@tanstack/react-query-next-experimental
npm i https://pkg.pr.new/@tanstack/react-query-next-experimental@9719
@tanstack/react-query-persist-client
npm i https://pkg.pr.new/@tanstack/react-query-persist-client@9719
@tanstack/solid-query
npm i https://pkg.pr.new/@tanstack/solid-query@9719
@tanstack/solid-query-devtools
npm i https://pkg.pr.new/@tanstack/solid-query-devtools@9719
@tanstack/solid-query-persist-client
npm i https://pkg.pr.new/@tanstack/solid-query-persist-client@9719
@tanstack/svelte-query
npm i https://pkg.pr.new/@tanstack/svelte-query@9719
@tanstack/svelte-query-devtools
npm i https://pkg.pr.new/@tanstack/svelte-query-devtools@9719
@tanstack/svelte-query-persist-client
npm i https://pkg.pr.new/@tanstack/svelte-query-persist-client@9719
@tanstack/vue-query
npm i https://pkg.pr.new/@tanstack/vue-query@9719
@tanstack/vue-query-devtools
npm i https://pkg.pr.new/@tanstack/vue-query-devtools@9719
commit: 2d1888f