Skip to content

chore(eslint.config): enable the 'jsdoc' rules outside the recommended config that have no violations - #11855

Merged
sukvvon merged 1 commit into
mainfrom
chore/eslint-jsdoc-enable-non-recommended-rules
Oct 3, 2026
Merged

sukvvon merged 1 commit into
mainfrom
chore/eslint-jsdoc-enable-non-recommended-rules

Conversation

@sukvvon

@sukvvon sukvvon commented Oct 3, 2026

Copy link
Copy Markdown
Member

🎯 Changes

Enables these jsdoc/* rules as error in the tanstack/query/jsdoc config object of the root eslint.config.js. They are not part of flat/recommended-typescript-error, and none of them has any violation:

Rule What it reports
jsdoc/check-template-names @template names that don't match the type parameters
jsdoc/no-bad-blocks Comments like /* @param ... */ that are missing the second asterisk
jsdoc/no-blank-block-descriptions Blank description lines
jsdoc/no-blank-blocks Empty /** */ blocks
jsdoc/require-asterisk-prefix Lines inside a block without the * prefix
jsdoc/require-hyphen-before-param-description @param descriptions without the - separator
jsdoc/require-next-description @next tags without a description
jsdoc/require-template-description @template tags without a description
jsdoc/require-throws-description @throws tags without a description
jsdoc/require-yields-description @yields tags without a description

✅ 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).

@sukvvon sukvvon self-assigned this Oct 3, 2026
@changeset-bot

changeset-bot Bot commented Oct 3, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 250c085

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

nx-cloud Bot commented Oct 3, 2026 •

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit 250c085

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

☁️ Nx Cloud last updated this comment at 2026-10-03 19:51:35 UTC

@sukvvon
sukvvon merged commit 6c75523 into main Oct 3, 2026
7 of 8 checks passed
@sukvvon
sukvvon deleted the chore/eslint-jsdoc-enable-non-recommended-rules branch October 3, 2026 19:46
@github-actions

github-actions Bot commented Oct 3, 2026

Copy link
Copy Markdown
Contributor

🚀 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

@github-actions

github-actions Bot commented Oct 3, 2026

Copy link
Copy Markdown
Contributor

size-limit report 📦

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

@coderabbitai

coderabbitai Bot commented Oct 3, 2026

Copy link
Copy Markdown
Contributor

Review in Change Stack →

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

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

⚙️ Run configuration
  • Configuration used: Repository: TanStack/query/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 2f4e12a1-b3e7-4572-b5a9-a4a62b0463da
📥 Commits

Reviewing files that changed from the base of the PR and between 327b6b9 and 250c085.

📒 Files selected for processing (1)
  • eslint.config.js
 ________________________________________________________________________________________________________________________________
< Design using services. Design in terms of services-independent, concurrent objects behind well-defined, consistent interfaces. >
 --------------------------------------------------------------------------------------------------------------------------------
  \
   \   (\__/)
       (•ㅅ•)
       /   づ
✨ 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant