feat(eslint): add type-checked configuration for eslint plugin by Newbie012 · Pull Request #8966 · TanStack/query

Newbie012 · 2025-04-07T09:44:13Z

Created a new configuration for type-checked rules in the ESLint plugin. Added a flat/recommendedTypeChecked config that includes the no-void-query-fn rule which requires TypeScript type information. Added an example project demonstrating the type-checked ESLint setup and updated the documentation to explain how to use it.

Created a new configuration for type-checked rules in the ESLint plugin. Added a `flat/recommendedTypeChecked` config that includes the `no-void-query-fn` rule which requires TypeScript type information. Added an example project demonstrating the type-checked ESLint setup and updated the documentation to explain how to use it.

Copilot

Copilot reviewed 10 out of 15 changed files in this pull request and generated no comments.

Files not reviewed (5)

examples/react/eslint-type-checked/.gitignore: Language not supported
examples/react/eslint-type-checked/index.html: Language not supported
examples/react/eslint-type-checked/package.json: Language not supported
examples/react/eslint-type-checked/tsconfig.json: Language not supported
pnpm-lock.yaml: Language not supported

Comments suppressed due to low confidence (2)

packages/eslint-plugin-query/src/tests/no-void-query-fn.test.ts:11

[nitpick] The naming of 'ruleTesterTypeChecked' versus the later 'ruleTester' may be confusing. Consider using consistently descriptive names to clearly differentiate tests for type-checked and non-type-checked scenarios.

const ruleTesterTypeChecked = new RuleTester({

examples/react/eslint-type-checked/eslint.config.js:15

Verify that 'projectService' is the correct parser option to enable type-aware linting, as standard configurations often use the 'project' property. If this is a mistake, updating it may help ensure proper type-checking.

projectService: true,

nx-cloud · 2025-04-07T09:44:49Z

View your CI Pipeline Execution ↗ for commit 26f5908.

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

☁️ Nx Cloud last updated this comment at 2025-04-07 16:42:59 UTC

pkg-pr-new · 2025-04-07T09:47:22Z

More templates

@tanstack/angular-query-devtools-experimental

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

@tanstack/angular-query-experimental

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 26f5908

github-actions · 2025-04-07T09:47:24Z

Sizes for commit 26f5908:

Branch	Bundle Size
Main
This PR

Newbie012 · 2025-04-07T10:05:59Z

@TkDodo I think something is off with the current nx configuration. It seems like test:lib actually depends on build rather than compile. As you can see in the failing CI, some of the pacakges failed to test:lib since they weren't able to import from query-core (since it was only compiled rather than build)

TkDodo · 2025-04-07T11:45:25Z

It seems like test:lib actually depends on build rather than compile

yes, we are aware and working on it.

TkDodo · 2025-04-07T11:50:11Z

@Newbie012 I’ve temporarily set build as a dependency for test:lib to work around this problem.

…e-checked-configuration

codecov · 2025-04-07T12:12:29Z

Codecov Report

Attention: Patch coverage is 33.33333% with 2 lines in your changes missing coverage. Please review.

Project coverage is 44.30%. Comparing base (97c8d84) to head (26f5908).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #8966   +/-   ##
=======================================
  Coverage   44.30%   44.30%           
=======================================
  Files         202      202           
  Lines        8058     8060    +2     
  Branches     1784     1776    -8     
=======================================
+ Hits         3570     3571    +1     
- Misses       4060     4061    +1     
  Partials      428      428

Components	Coverage Δ
@tanstack/angular-query-devtools-experimental	`∅ <ø> (∅)`
@tanstack/angular-query-experimental	`88.08% <ø> (ø)`
@tanstack/eslint-plugin-query	`88.05% <33.33%> (-0.15%)`	⬇️
@tanstack/query-async-storage-persister	`43.85% <ø> (ø)`
@tanstack/query-broadcast-client-experimental	`∅ <ø> (∅)`
@tanstack/query-codemods	`0.00% <ø> (ø)`
@tanstack/query-core	`94.77% <ø> (ø)`
@tanstack/query-devtools	`3.61% <ø> (ø)`
@tanstack/query-persist-client-core	`57.73% <ø> (ø)`
@tanstack/query-sync-storage-persister	`84.61% <ø> (ø)`
@tanstack/react-query	`95.42% <ø> (ø)`
@tanstack/react-query-devtools	`10.00% <ø> (ø)`
@tanstack/react-query-next-experimental	`∅ <ø> (∅)`
@tanstack/react-query-persist-client	`100.00% <ø> (ø)`
@tanstack/solid-query	`78.48% <ø> (ø)`
@tanstack/solid-query-devtools	`∅ <ø> (∅)`
@tanstack/solid-query-persist-client	`100.00% <ø> (ø)`
@tanstack/svelte-query	`88.15% <ø> (ø)`
@tanstack/svelte-query-devtools	`∅ <ø> (∅)`
@tanstack/svelte-query-persist-client	`100.00% <ø> (ø)`
@tanstack/vue-query	`71.01% <ø> (ø)`
@tanstack/vue-query-devtools	`∅ <ø> (∅)`

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

…anStack/query into feat-eslint-type-checked-configuration

Newbie012 requested a review from Copilot April 7, 2025 09:44

github-actions bot added documentation Improvements or additions to documentation package: eslint-plugin-query labels Apr 7, 2025

Copilot AI reviewed Apr 7, 2025

View reviewed changes

Newbie012 mentioned this pull request Apr 7, 2025

[lint]: no-rest-destructuring does not report on custom hooks #8951

Open

Merge branch 'main' into feat-eslint-type-checked-configuration

ad95d2c

Merge branch 'main' of github.com:TanStack/query into feat-eslint-typ…

ce8777f

…e-checked-configuration

Newbie012 added 3 commits April 7, 2025 16:32

Merge branch 'main' into feat-eslint-type-checked-configuration

f33f24d

Merge branch 'feat-eslint-type-checked-configuration' of github.com:T…

f47adb0

…anStack/query into feat-eslint-type-checked-configuration

Merge branch 'main' into feat-eslint-type-checked-configuration

26f5908

lachlancollins force-pushed the main branch from 5d7869e to 18a12ca Compare September 27, 2025 23:43

benpsnyder mentioned this pull request Mar 30, 2026

ci: add oxlint as fast pre-lint pass before ESLint #10355

Open

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(eslint): add type-checked configuration for eslint plugin#8966

feat(eslint): add type-checked configuration for eslint plugin#8966
Newbie012 wants to merge 6 commits intomainfrom
feat-eslint-type-checked-configuration

Newbie012 commented Apr 7, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

nx-cloud bot commented Apr 7, 2025 •

edited

Loading

Uh oh!

pkg-pr-new bot commented Apr 7, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Apr 7, 2025 •

edited

Loading

Uh oh!

Newbie012 commented Apr 7, 2025

Uh oh!

TkDodo commented Apr 7, 2025

Uh oh!

TkDodo commented Apr 7, 2025

Uh oh!

codecov bot commented Apr 7, 2025 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

Newbie012 commented Apr 7, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

nx-cloud bot commented Apr 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pkg-pr-new bot commented Apr 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Apr 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Newbie012 commented Apr 7, 2025

Uh oh!

TkDodo commented Apr 7, 2025

Uh oh!

TkDodo commented Apr 7, 2025

Uh oh!

codecov bot commented Apr 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

nx-cloud bot commented Apr 7, 2025 •

edited

Loading

pkg-pr-new bot commented Apr 7, 2025 •

edited

Loading

github-actions bot commented Apr 7, 2025 •

edited

Loading

codecov bot commented Apr 7, 2025 •

edited

Loading