Skip to content

refactor(examples/lit/basic): infer the controller types from the query and mutation functions instead of passing generics - #12184

Merged
sukvvon merged 1 commit into
mainfrom
refactor/lit-basic-infer-controller-types
Oct 20, 2026
Merged

sukvvon merged 1 commit into
mainfrom
refactor/lit-basic-infer-controller-types

Conversation

@sukvvon

@sukvvon sukvvon commented Oct 20, 2026 •

Copy link
Copy Markdown
Member

🎯 Changes

The lit basic example passed explicit generics such as createQueryController<TodosResponse, Error> and createMutationController<Todo, Error, string>, although the typed fetchTodosFromServer and addTodoOnServer already give the same types. Remove the generics in basic-query.ts, main.ts, and mutation.ts, along with the type imports they leave unused.

lifecycle-contract.ts keeps its generics, because its queryFn always throws and the data comes from setQueryData.

✅ 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

  • Refactor
    • Simplified the basic Lit examples by relying on automatic type inference for query and mutation controllers.
    • Removed unused type imports while preserving existing todo-fetching and cache-update behavior.

…ry and mutation functions instead of passing generics
@sukvvon sukvvon self-assigned this Oct 20, 2026
@changeset-bot

changeset-bot Bot commented Oct 20, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 225a6f7

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 20, 2026 •

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit 225a6f7

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

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

@github-actions

Copy link
Copy Markdown
Contributor

🚀 Changeset Version Preview

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

@pkg-pr-new

pkg-pr-new Bot commented Oct 20, 2026

Copy link
Copy Markdown
More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 225a6f7

@github-actions

Copy link
Copy Markdown
Contributor

size-limit report 📦

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

@coderabbitai

coderabbitai Bot commented Oct 20, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

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: c0dd7aa1-76ab-4571-a371-30b5748a1204
📥 Commits

Reviewing files that changed from the base of the PR and between 4ea78d6 and 225a6f7.

📒 Files selected for processing: 3
  • examples/lit/basic/src/basic-query.ts
  • examples/lit/basic/src/main.ts
  • examples/lit/basic/src/mutation.ts

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

📝 Walkthrough

The Lit basic examples now rely on inferred types for query and mutation controllers. The changes also remove unused type imports.

Changes: Lit basic controller inference

Layer / File(s) Summary
Infer controller types
examples/lit/basic/src/basic-query.ts, examples/lit/basic/src/main.ts, examples/lit/basic/src/mutation.ts
Query and mutation controller declarations omit explicit generic type parameters. Unused type imports are removed. The existing query configuration and mutation cache updates remain unchanged.

Priority: ⬇️ Low

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

Change: Refactor

Suggested reviewers: chughgaurav

Merge Risk: ⚪ Minimal · up to 225a6

No actionable issue remains in the Lit basic example changes; they are ready to merge after normal checks.

Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed The title clearly and accurately summarizes the main change: inferring controller types instead of passing explicit generics.
Description check Passed The description includes all required sections, explains the changes and motivation, completes the checklist, and identifies the release impact as 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 3…
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.
Full details: Docstring Coverage

Explanation

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 3 files.

✨ 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
sukvvon merged commit 45e8a5e into main Oct 20, 2026
9 checks passed
@sukvvon
sukvvon deleted the refactor/lit-basic-infer-controller-types branch October 20, 2026 03:19
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