docs(scripts/generate-docs): treat parenthesized '() => T' members as wrapper aliases by sukvvon · Pull Request #12217 · TanStack/query

sukvvon · 2026-10-21T01:28:43Z

🎯 Changes

In isWrapperAlias (scripts/generate-docs.ts), strip the outer parentheses from each union member before comparing it to T or () => T. A union prints a function member as (() => T), so an alias like lit's Accessor<T> = T | (() => T) was not treated as a wrapper alias and its options section only got a "Built from" link.
Regenerate the lit reference docs. createQueryController, createInfiniteQueryController, createMutationController, createQueriesController, useIsFetching, and useIsMutating now show the full property table for their Accessor options. No other adapter's docs change.

✅ 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
- Expanded Lit API reference documentation with detailed option and filter tables, including types, defaults, and behavior.
- Added comprehensive guidance for query, mutation, infinite-query, multi-query, fetching, and mutation-filter options.
Chores
- Improved documentation generation for union types wrapped in parentheses.

… wrapper aliases

…Accessor' options

changeset-bot · 2026-10-21T01:28:49Z

⚠️ No Changeset found

Latest commit: c89a4f5

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-21T01:29:08Z

View your CI Pipeline Execution ↗ for commit c89a4f5

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

☁️ Nx Cloud last updated this comment at 2026-10-21 03:42:08 UTC

github-actions · 2026-10-21T01:30:00Z

🚀 Changeset Version Preview

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

pkg-pr-new · 2026-10-21T01:30:46Z

More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: c89a4f5

github-actions · 2026-10-21T01:30:52Z

size-limit report 📦

Path	Size
react full	11.76 KB (0%)
react minimal	8.59 KB (0%)

coderabbitai · 2026-10-21T01:30:55Z

Important

Review skipped

Review was skipped as selected files did not have any reviewable changes.

⚙️ Run configuration

Configuration used: Repository: TanStack/query/.coderabbit.yaml
Review profile: CHILL
Plan: Advanced
Run ID: 20a81a36-75e0-4cde-a0c7-7e089bef8bc2

📥 Commits

Reviewing files that changed from the base of the PR and between 2b9d83b and c89a4f5.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

🔍 Trigger review

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: 4e5f72a7-9570-43fb-be22-fc7c136903b0

📥 Commits

Reviewing files that changed from the base of the PR and between 90e331d and 2b9d83b.

📒 Files selected for processing: 7

docs/framework/lit/reference/functions/createInfiniteQueryController.md
docs/framework/lit/reference/functions/createMutationController.md
docs/framework/lit/reference/functions/createQueriesController.md
docs/framework/lit/reference/functions/createQueryController.md
docs/framework/lit/reference/functions/useIsFetching.md
docs/framework/lit/reference/functions/useIsMutating.md
scripts/generate-docs.ts

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

Lit reference pages now document query, mutation, and filter properties in tables. The documentation generator also strips surrounding parentheses from union members before checking wrapper aliases.

Changes: Lit reference documentation

Layer / File(s)	Summary
Reference tables and generator normalization `docs/framework/lit/reference/functions/createQueryController.md`, `docs/framework/lit/reference/functions/createInfiniteQueryController.md`, `docs/framework/lit/reference/functions/createMutationController.md`, `docs/framework/lit/reference/functions/createQueriesController.md`, `docs/framework/lit/reference/functions/useIsFetching.md`, `docs/framework/lit/reference/functions/useIsMutating.md`, `scripts/generate-docs.ts`	The reference pages replace generic type references with property tables for query, mutation, and filter options. The generator strips surrounding parentheses from each union member before checking wrapper aliases.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Bug fix

Suggested reviewers: alemtuzlak, lachlancollins

Merge Risk: ⚪ Minimal · up to 2b9d8

This documentation-only change has no established merge-blocking risk.

Pre-merge checks: 5

Check name	Status	Explanation
Title check		The title clearly and concisely describes the main change to parenthesized wrapper aliases in scripts/generate-docs.ts.
Description check		The description explains the implementation, motivation, regenerated documentation, test status, checklist completion, and release impact.
Docstring Coverage		Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 1 files. (6 skipped: 6 …
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

Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 1 files. (6 skipped: 6 unsupported.)

✨ Finishing Touches

📝 Generate docstrings

Commit to this branch
Create a new PR

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

sukvvon added 2 commits October 21, 2026 10:28

docs(scripts/generate-docs): treat parenthesized '() => T' members as…

48784f2

… wrapper aliases

docs(lit-query): regenerate reference docs with property tables for '…

2b9d83b

…Accessor' options

sukvvon requested a review from a team as a code owner October 21, 2026 01:28

sukvvon self-assigned this Oct 21, 2026

Merge branch 'main' into docs/generate-docs-parenthesized-wrapper-alias

c89a4f5

Navigation Menu

Repository navigation

docs(scripts/generate-docs): treat parenthesized '() => T' members as wrapper aliases - #12217

docs(scripts/generate-docs): treat parenthesized '() => T' members as wrapper aliases#12217
sukvvon wants to merge 3 commits into
mainfrom
docs/generate-docs-parenthesized-wrapper-alias

sukvvon commented Oct 21, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

changeset-bot Bot commented Oct 21, 2026 •

edited

Loading

Uh oh!

nx-cloud Bot commented Oct 21, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Oct 21, 2026

Uh oh!

pkg-pr-new Bot commented Oct 21, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Oct 21, 2026

Uh oh!

coderabbitai Bot commented Oct 21, 2026 •

edited

Loading

Review skipped

Uh oh!

This branch has not been deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

sukvvon commented Oct 21, 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 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

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

Uh oh!

Uh oh!

github-actions Bot commented Oct 21, 2026

🚀 Changeset Version Preview

Uh oh!

pkg-pr-new Bot commented Oct 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Oct 21, 2026

size-limit report 📦

Uh oh!

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

Uh oh!

Review skipped

Uh oh!

This branch has not been deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

sukvvon commented Oct 21, 2026 •

edited by coderabbitai Bot

Loading

changeset-bot Bot commented Oct 21, 2026 •

edited

Loading

nx-cloud Bot commented Oct 21, 2026 •

edited

Loading

pkg-pr-new Bot commented Oct 21, 2026 •

edited

Loading

coderabbitai Bot commented Oct 21, 2026 •

edited

Loading