chore(eslint.config): require JSDoc on exported interfaces and type aliases by sukvvon · Pull Request #11876 · TanStack/query

sukvvon · 2026-10-04T02:54:25Z

🎯 Changes

Extends jsdoc/require-jsdoc in the root eslint.config.js to exported interfaces and type aliases:

'jsdoc/require-jsdoc': [
  'error',
  {
    contexts: [
      'ExportNamedDeclaration > TSInterfaceDeclaration',
      'ExportNamedDeclaration > TSTypeAliasDeclaration',
    ],
  },
],

Only exported declarations are matched, so local helper types still don't need a JSDoc block.
The default require option is kept, so function declarations still require one whether they are exported or not.
Every exported interface and type alias already has a description, so there are no violations.

✅ 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

Chores
- Updated code quality checks to require documentation comments for exported TypeScript interfaces and type aliases. This change affects development standards and does not change user-facing functionality.

…liases

changeset-bot · 2026-10-04T02:54:29Z

⚠️ No Changeset found

Latest commit: 6a63fbf

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-04T02:54:51Z

View your CI Pipeline Execution ↗ for commit 6a63fbf

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

☁️ Nx Cloud last updated this comment at 2026-10-04 02:59:20 UTC

github-actions · 2026-10-04T02:55:17Z

🚀 Changeset Version Preview

1 package(s) bumped directly, 24 bumped as dependents.

🟩 Patch bumps

Package	Version	Reason
`@tanstack/query-core`	5.104.1 → 5.104.2	Changeset
`@tanstack/angular-query-experimental`	5.104.1 → 5.104.2	Dependent
`@tanstack/angular-query-persist-client`	5.104.1 → 5.104.2	Dependent
`@tanstack/eslint-plugin-query`	5.104.1 → 5.104.2	Dependent
`@tanstack/lit-query`	0.2.26 → 0.2.27	Dependent
`@tanstack/preact-query`	5.104.1 → 5.104.2	Dependent
`@tanstack/preact-query-devtools`	5.104.1 → 5.104.2	Dependent
`@tanstack/preact-query-persist-client`	5.104.1 → 5.104.2	Dependent
`@tanstack/query-async-storage-persister`	5.104.1 → 5.104.2	Dependent
`@tanstack/query-broadcast-client-experimental`	5.104.1 → 5.104.2	Dependent
`@tanstack/query-devtools`	5.104.1 → 5.104.2	Dependent
`@tanstack/query-persist-client-core`	5.104.1 → 5.104.2	Dependent
`@tanstack/query-sync-storage-persister`	5.104.1 → 5.104.2	Dependent
`@tanstack/react-query`	5.104.1 → 5.104.2	Dependent
`@tanstack/react-query-devtools`	5.104.1 → 5.104.2	Dependent
`@tanstack/react-query-next-experimental`	5.104.1 → 5.104.2	Dependent
`@tanstack/react-query-persist-client`	5.104.1 → 5.104.2	Dependent
`@tanstack/solid-query`	5.104.1 → 5.104.2	Dependent
`@tanstack/solid-query-devtools`	5.104.1 → 5.104.2	Dependent
`@tanstack/solid-query-persist-client`	5.104.1 → 5.104.2	Dependent
`@tanstack/svelte-query`	6.3.1 → 6.3.2	Dependent
`@tanstack/svelte-query-devtools`	6.3.1 → 6.3.2	Dependent
`@tanstack/svelte-query-persist-client`	6.3.1 → 6.3.2	Dependent
`@tanstack/vue-query`	5.104.1 → 5.104.2	Dependent
`@tanstack/vue-query-devtools`	6.3.1 → 6.3.2	Dependent

coderabbitai · 2026-10-04T02:56:42Z

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

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: 43f3151d-4b6f-4c5c-a9b3-4f5b25133682

📥 Commits

Reviewing files that changed from the base of the PR and between 5a8fa03 and 6a63fbf.

📒 Files selected for processing (1)

eslint.config.js

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

📝 Walkthrough

Walkthrough

The ESLint configuration now requires JSDoc for exported TypeScript interfaces and type aliases.

Changes

Exported TypeScript JSDoc rule

Layer / File(s)	Summary
Configure exported declaration checks `eslint.config.js`	The `jsdoc/require-jsdoc` rule now applies to exported interface and type-alias declarations.

Priority: ⬇️ Low

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

Change: Other

Merge Risk: ⚪ Minimal · up to 6a63f

This is a lint-configuration change only and does not affect runtime behavior. The author reports that existing exported types already have descriptions, so no new lint failures are expected. Merge risk is minimal.

Architecture Summary

Architecture risk: 🔵 Low · up to 6a63f

The change affects 1 system.

Changed systems: eslint.config.js

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

observed — eslint.config.js (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

observed — Modified behavior in eslint.config.js: Adds jsdoc/require-jsdoc as an error for exported interface and type-alias declarations.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely describes the change to require JSDoc for exported interfaces and type aliases.
Description check	✅ Passed	The description explains the change and its scope, completes the checklist, and identifies the release impact as docs/CI/dev-only.
Docstring Coverage	✅ Passed	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 1…
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.

✨ Finishing Touches

📝 Generate docstrings

Commit to this branch
Create a new PR

🧪 Generate unit tests (beta)

Commit to this branch
Create a new PR

Autopilot · 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-04T02:56:43Z

More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 6a63fbf

github-actions · 2026-10-04T02:57:30Z

size-limit report 📦

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

chore(eslint.config): require JSDoc on exported interfaces and type a…

6a63fbf

…liases

sukvvon self-assigned this Oct 4, 2026

sukvvon merged commit c1c27a7 into main Oct 4, 2026
9 checks passed

sukvvon deleted the chore/eslint-jsdoc-require-exported-types branch October 4, 2026 03:28

Navigation Menu

Repository navigation

chore(eslint.config): require JSDoc on exported interfaces and type aliases - #11876

chore(eslint.config): require JSDoc on exported interfaces and type aliases#11876
sukvvon merged 1 commit into
mainfrom
chore/eslint-jsdoc-require-exported-types

sukvvon commented Oct 4, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

changeset-bot Bot commented Oct 4, 2026

Uh oh!

nx-cloud Bot commented Oct 4, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Oct 4, 2026

Uh oh!

coderabbitai Bot commented Oct 4, 2026 •

edited

Loading

Walkthrough

Changes

Uh oh!

pkg-pr-new Bot commented Oct 4, 2026

Uh oh!

github-actions Bot commented Oct 4, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

sukvvon commented Oct 4, 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 4, 2026

⚠️ No Changeset found

Uh oh!

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

Uh oh!

Uh oh!

github-actions Bot commented Oct 4, 2026

🚀 Changeset Version Preview

🟩 Patch bumps

Uh oh!

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

Uh oh!

Walkthrough

Changes

Architecture Summary

Uh oh!

pkg-pr-new Bot commented Oct 4, 2026

Uh oh!

github-actions Bot commented Oct 4, 2026

size-limit report 📦

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

sukvvon commented Oct 4, 2026 •

edited by coderabbitai Bot

Loading

nx-cloud Bot commented Oct 4, 2026 •

edited

Loading

coderabbitai Bot commented Oct 4, 2026 •

edited

Loading