query icon indicating copy to clipboard operation
query copied to clipboard

docs: add missing eslint rules from left navigation

Open espada-edalex opened this issue 4 months ago • 4 comments

🎯 Changes

Add missing ESLint rules to the left hand side navigation

image

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.

espada-edalex avatar Oct 01 '25 01:10 espada-edalex

⚠️ 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

changeset-bot[bot] avatar Oct 01 '25 01:10 changeset-bot[bot]

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 config
docs/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.

❤️ Share

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

coderabbitai[bot] avatar Oct 01 '25 01:10 coderabbitai[bot]

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

nx-cloud[bot] avatar Oct 01 '25 01:10 nx-cloud[bot]

More templates

@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

pkg-pr-new[bot] avatar Oct 01 '25 01:10 pkg-pr-new[bot]