docs(eslint/eslint-plugin-query): add an 'Oxlint' section for using the plugin through 'jsPlugins' by sukvvon · Pull Request #12041 · TanStack/query

sukvvon · 2026-10-16T17:29:22Z

🎯 Changes

Adds an Oxlint section to docs/eslint/eslint-plugin-query.md describing how to use the plugin through Oxlint's JS plugins support (alpha).

oxlint.config.ts: recommended setup spreading pluginQuery.configs.recommended.rules (or recommendedStrict.rules), and a custom setup.
.oxlintrc.json: custom setup, since a JSON config cannot import the configs of the plugin.
A note that no-void-query-fn does not report anything under Oxlint, as Oxlint does not provide type information to JS plugins yet.

✅ Checklist

I have followed the steps in the Contributing guide.
I have tested code changes locally with pnpm run test:pr, or these tests do not apply to this pull request.
I have followed the AI contribution policy and fully understand the code in this pull request, including any code generated with AI assistance.

🚀 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
- Added guidance for configuring the ESLint Query plugin with Oxlint, including TypeScript and JSON examples.
- Clarified that no-void-query-fn does not report issues in Oxlint because type information is not available to JS plugins.

…he plugin through 'jsPlugins'

changeset-bot · 2026-10-16T17:29:29Z

⚠️ No Changeset found

Latest commit: a34b5ab

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

nx-cloud · 2026-10-16T17:29:58Z

View your CI Pipeline Execution ↗ for commit a34b5ab

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

☁️ Nx Cloud last updated this comment at 2026-10-16 17:33:11 UTC

github-actions · 2026-10-16T17:30:14Z

🚀 Changeset Version Preview

No changeset entries found. Merging this PR will not cause a version bump for any packages.

coderabbitai · 2026-10-16T17:31:01Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository: TanStack/query/.coderabbit.yaml
Review profile: CHILL
Plan: Advanced
Run ID: c2c5409a-931a-48c1-8355-2048d983f336

📥 Commits

Reviewing files that changed from the base of the PR and between e90c0bd and a34b5ab.

📒 Files selected for processing: 1

docs/eslint/eslint-plugin-query.md

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 9 remain after this review.

📝 Walkthrough

The ESLint Query plugin guide now documents Oxlint setup. It includes TypeScript recommended and custom configurations, a JSON configuration, and a note about no-void-query-fn under Oxlint.

Changes: Oxlint configuration

Layer / File(s)	Summary
Document plugin setup `docs/eslint/eslint-plugin-query.md`	Adds TypeScript recommended and custom setup examples, plus a JSON example for registering the plugin and enabling rules. Notes that `no-void-query-fn` does not report under Oxlint because its JavaScript plugins do not receive type information.

Priority: ⬇️ Low

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

Change: Other

Merge Risk: ⚪ Minimal · up to a34b5

The Oxlint examples match the plugin’s declarations, and no actionable documentation issue was found; this change appears ready to merge.

Pre-merge checks: 5

Check name	Status	Explanation
Title check		The title clearly identifies the documentation file and the primary change: adding an Oxlint section that explains plugin use through jsPlugins.
Description check		The description follows the required template. It explains the changes, completes the checklist, and identifies the work as documentation-only with no release impact.
Docstring Coverage		No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		Check skipped because no linked issues were found for this pull request.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches

🧪 Generate unit tests (beta)

Commit to this branch
Create a new PR

Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.}

pkg-pr-new · 2026-10-16T17:33:05Z

More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: a34b5ab

github-actions · 2026-10-16T17:33:12Z

size-limit report 📦

Path	Size
react full	11.73 KB (0%)
react minimal	8.58 KB (0%)

docs(eslint/eslint-plugin-query): add an 'Oxlint' section for using t…

a34b5ab

…he plugin through 'jsPlugins'

sukvvon self-assigned this Oct 16, 2026

sukvvon merged commit fceed34 into main Oct 16, 2026
9 checks passed

sukvvon deleted the docs/eslint-plugin-query-oxlint-section branch October 16, 2026 17:40

Navigation Menu

Repository navigation

docs(eslint/eslint-plugin-query): add an 'Oxlint' section for using the plugin through 'jsPlugins' - #12041

docs(eslint/eslint-plugin-query): add an 'Oxlint' section for using the plugin through 'jsPlugins'#12041
sukvvon merged 1 commit into
mainfrom
docs/eslint-plugin-query-oxlint-section

sukvvon commented Oct 16, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

changeset-bot Bot commented Oct 16, 2026

Uh oh!

nx-cloud Bot commented Oct 16, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Oct 16, 2026

Uh oh!

coderabbitai Bot commented Oct 16, 2026 •

edited

Loading

Uh oh!

pkg-pr-new Bot commented Oct 16, 2026

Uh oh!

github-actions Bot commented Oct 16, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

sukvvon commented Oct 16, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🎯 Changes

✅ Checklist

🚀 Release Impact

Summary by CodeRabbit

Uh oh!

changeset-bot Bot commented Oct 16, 2026

⚠️ No Changeset found

Uh oh!

nx-cloud Bot commented Oct 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Oct 16, 2026

🚀 Changeset Version Preview

Uh oh!

coderabbitai Bot commented Oct 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pkg-pr-new Bot commented Oct 16, 2026

Uh oh!

github-actions Bot commented Oct 16, 2026

size-limit report 📦

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

sukvvon commented Oct 16, 2026 •

edited by coderabbitai Bot

Loading

nx-cloud Bot commented Oct 16, 2026 •

edited

Loading

coderabbitai Bot commented Oct 16, 2026 •

edited

Loading