chore(angular-query): remove jsdoc eslint rules #9803

arnoud-dv · 2025-10-23T13:28:19Z

🎯 Changes

Only the Angular adapter has these rules and it's distracting

✅ Checklist

I have followed the steps in the Contributing guide.
I have tested this code locally with pnpm run test:pr.

🚀 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
- Removed JSDoc-related ESLint configuration and development dependencies from the Angular Query experimental package build toolchain.

changeset-bot · 2025-10-23T13:28:24Z

⚠️ No Changeset found

Latest commit: 1e2076f

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

coderabbitai · 2025-10-23T13:28:39Z

Walkthrough

Removed JSDoc ESLint plugin and its associated configuration from the angular-query-experimental package. This includes removing the eslint-plugin-jsdoc dependency, deleting all jsdoc-related lint rules from the ESLint config, and removing corresponding lint directive comments from test files.

Changes

Cohort / File(s)	Summary
JSDoc ESLint configuration removal `packages/angular-query-experimental/eslint.config.js`	Removed pluginJsdoc config block and all jsdoc rules (require-hyphen-before-param-description, sort-tags, require-throws, check-tag-names); also removed jsdoc/require-returns disablement from tests override
Dependency cleanup `packages/angular-query-experimental/package.json`	Removed eslint-plugin-jsdoc devDependency (^50.5.0)
Lint directive cleanup `packages/angular-query-experimental/src/__tests__/test-utils.ts`	Removed ESLint directive comment disabling jsdoc and parameter documentation checks

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

feat(angular-query): integrate with Angular v19+ PendingTasks for whenStable() support #9666: Added jsdoc/require-returns rule disablement to the same ESLint config file that is now being partially removed in this PR.

Poem

🐰 Hoppity-hop, the docs are done,
No JSDoc rules to check and run,
The linter's load is light once more,
Clean config files we do adore!
✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run `@coderabbitai generate docstrings` to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The pull request title "chore(angular-query): remove jsdoc eslint rules" clearly and directly summarizes the primary change in the PR. It specifies the scope (angular-query) and the main action (removing jsdoc eslint rules), which aligns perfectly with the actual modifications: removal of jsdoc ESLint configuration, deletion of the eslint-plugin-jsdoc dependency, and removal of related ESLint directive comments. The title is concise, specific, and provides sufficient context for a teammate reviewing the commit history.
Description Check	✅ Passed	The pull request description follows the required template structure with all three main sections present. The Changes section includes a clear motivation ("Only the Angular adapter has these rules and it's distracting"), both checklist items are properly completed with checkmarks indicating the contributor followed the contributing guide and tested locally, and the Release Impact section correctly indicates this is a docs/CI/dev-only change with no changeset required. The description is complete and addresses all required template sections.

✨ Finishing touches

📝 Docstrings were successfully generated.

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9d5ea11 and 1e2076f.

⛔ Files ignored due to path filters (1)

pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (3)

packages/angular-query-experimental/eslint.config.js (0 hunks)
packages/angular-query-experimental/package.json (0 hunks)
packages/angular-query-experimental/src/__tests__/test-utils.ts (0 hunks)

💤 Files with no reviewable changes (3)

packages/angular-query-experimental/src/tests/test-utils.ts
packages/angular-query-experimental/eslint.config.js
packages/angular-query-experimental/package.json

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

GitHub Check: Preview
GitHub Check: Test

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

nx-cloud · 2025-10-23T13:29:03Z

View your CI Pipeline Execution ↗ for commit 1e2076f

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

☁️ Nx Cloud last updated this comment at 2025-10-23 13:31:29 UTC

pkg-pr-new · 2025-10-23T13:30:07Z

More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 1e2076f

codecov · 2025-10-23T13:31:49Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (main@907087f). Learn more about missing BASE report.
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #9803   +/-   ##
=======================================
  Coverage        ?   45.74%           
=======================================
  Files           ?      200           
  Lines           ?     8404           
  Branches        ?     1917           
=======================================
  Hits            ?     3844           
  Misses          ?     4112           
  Partials        ?      448

Components	Coverage Δ
@tanstack/angular-query-experimental	`93.85% <ø> (?)`
@tanstack/eslint-plugin-query	`83.56% <ø> (?)`
@tanstack/query-async-storage-persister	`43.85% <ø> (?)`
@tanstack/query-broadcast-client-experimental	`24.39% <ø> (?)`
@tanstack/query-codemods	`0.00% <ø> (?)`
@tanstack/query-core	`97.37% <ø> (?)`
@tanstack/query-devtools	`3.48% <ø> (?)`
@tanstack/query-persist-client-core	`80.00% <ø> (?)`
@tanstack/query-sync-storage-persister	`84.61% <ø> (?)`
@tanstack/query-test-utils	`77.77% <ø> (?)`
@tanstack/react-query	`96.01% <ø> (?)`
@tanstack/react-query-devtools	`10.00% <ø> (?)`
@tanstack/react-query-next-experimental	`∅ <ø> (?)`
@tanstack/react-query-persist-client	`100.00% <ø> (?)`
@tanstack/solid-query	`78.06% <ø> (?)`
@tanstack/solid-query-devtools	`61.90% <ø> (?)`
@tanstack/solid-query-persist-client	`100.00% <ø> (?)`
@tanstack/svelte-query	`∅ <ø> (?)`
@tanstack/svelte-query-devtools	`∅ <ø> (?)`
@tanstack/svelte-query-persist-client	`∅ <ø> (?)`
@tanstack/vue-query	`71.10% <ø> (?)`
@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.

coderabbitai · 2025-10-23T13:50:10Z

Note

Docstrings generation - SUCCESS
Generated docstrings for this pull request at #9804

@arnoud-dv

Docstrings generation was requested by @arnoud-dv. * #9803 (comment) The following files were modified: * `packages/angular-query-experimental/src/__tests__/test-utils.ts`

chore(angular-query): remove jsdoc eslint rules

1e2076f

github-actions bot added the package: angular-query-experimental label Oct 23, 2025

arnoud-dv merged commit 6c272bd into TanStack:main Oct 23, 2025
9 checks passed

arnoud-dv deleted the chore/angular-query-remove-jsdoc-eslint-rules branch October 23, 2025 13:50

coderabbitai bot mentioned this pull request Oct 23, 2025

📝 Add docstrings to chore/angular-query-remove-jsdoc-eslint-rules #9804

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

chore(angular-query): remove jsdoc eslint rules #9803

chore(angular-query): remove jsdoc eslint rules #9803

Uh oh!

arnoud-dv commented Oct 23, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

changeset-bot bot commented Oct 23, 2025

Uh oh!

coderabbitai bot commented Oct 23, 2025 •

edited

Loading

Uh oh!

nx-cloud bot commented Oct 23, 2025 •

edited

Loading

Uh oh!

pkg-pr-new bot commented Oct 23, 2025

Uh oh!

codecov bot commented Oct 23, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Oct 23, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

chore(angular-query): remove jsdoc eslint rules #9803

chore(angular-query): remove jsdoc eslint rules #9803

Uh oh!

Conversation

arnoud-dv commented Oct 23, 2025 • 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 23, 2025

⚠️ No Changeset found

Uh oh!

coderabbitai bot commented Oct 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Poem

Pre-merge checks and finishing touches

Uh oh!

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

Uh oh!

Uh oh!

pkg-pr-new bot commented Oct 23, 2025

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

coderabbitai bot commented Oct 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

arnoud-dv commented Oct 23, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Oct 23, 2025 •

edited

Loading

nx-cloud bot commented Oct 23, 2025 •

edited

Loading

codecov bot commented Oct 23, 2025 •

edited

Loading

coderabbitai bot commented Oct 23, 2025 •

edited

Loading