Skip to content

refactor(examples/react/rick-morty): type the API responses and share the queries with 'queryOptions' - #12068

Merged
sukvvon merged 1 commit into
mainfrom
refactor/examples-react-rick-morty-query-options
Oct 18, 2026
Merged

sukvvon merged 1 commit into
mainfrom
refactor/examples-react-rick-morty-query-options

Conversation

@sukvvon

@sukvvon sukvvon commented Oct 18, 2026 •

Copy link
Copy Markdown
Member

🎯 Changes

  • src/api.ts: adds Episode, Character, Location and Paginated<T> types, gives each fetch function a typed return value instead of any, and exports queryOptions factories for the episodes, episode, characters, character and location queries. The fetch functions are no longer exported.
  • Episodes.tsx, Episode.tsx, Characters.tsx, Character.tsx: use those factories in useQuery instead of inline queryKey/queryFn, and drop the : any annotations on the map callbacks, so ['episode', id] and ['character', id] are defined once and the data is typed.

✅ 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

  • Improvements
    • The Rick and Morty example now uses consistent query handling across character, episode, and location views, while preserving existing data requests and error behavior.
    • Data displayed in the example benefits from stronger type checking, helping keep character, episode, location, and paginated results consistent.

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

changeset-bot Bot commented Oct 18, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: d95c37d

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

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit d95c37d

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

☁️ Nx Cloud last updated this comment at 2026-10-18 03:34:38 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.

@coderabbitai

coderabbitai Bot commented Oct 18, 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: 2d06f274-7c58-441d-be15-916d1639c633
📥 Commits

Reviewing files that changed from the base of the PR and between 53bd787 and d95c37d.

📒 Files selected for processing: 5
  • examples/react/rick-morty/src/Character.tsx
  • examples/react/rick-morty/src/Characters.tsx
  • examples/react/rick-morty/src/Episode.tsx
  • examples/react/rick-morty/src/Episodes.tsx
  • examples/react/rick-morty/src/api.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

The Rick and Morty example now defines typed fetch helpers and reusable React Query option builders. Its character, episode, and location components use those builders instead of inline query configurations. Explicit any annotations were removed from mapped values.

Changes: Rick and Morty query options

Layer / File(s) Summary
Typed API queries
examples/react/rick-morty/src/api.ts
The API module adds response types, types the internal fetch helpers, and exports query-option builders for list and single-entity requests.
Component query usage
examples/react/rick-morty/src/Character.tsx, examples/react/rick-morty/src/Characters.tsx, examples/react/rick-morty/src/Episode.tsx, examples/react/rick-morty/src/Episodes.tsx
The components use the query-option builders instead of inline query configurations. Explicit any annotations are removed from mapped values.

Priority: ⬇️ Low

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

Change: Refactor

Suggested reviewers: lachlancollins

Merge Risk: ⚪ Minimal · up to d95c3

The example’s components use the shared queries without a detected compatibility issue. The change is mergeable after normal checks.

Pre-merge checks: Passed 4 · Failed 1

Failed 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%. Docstring coverage is scoped to functions touched by this diff. Analyzed 7 functions across 5 files. Write docstrings for the functions missing them to satisfy the coverage threshold.
Passed Passed checks: 4 passed
Check name Status Explanation
Title check Passed The title clearly summarizes the main changes: typing API responses and sharing React Query configurations with queryOptions.
Description check Passed The description covers the implementation changes, motivation, checklist, testing status, AI policy, and release impact. All required sections are present and complete.
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.
  • Fix all pre-merge checks with AI
✨ Finishing Touches: 💡 1
📝 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.

@pkg-pr-new

pkg-pr-new Bot commented Oct 18, 2026

Copy link
Copy Markdown
More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: d95c37d

@github-actions

Copy link
Copy Markdown
Contributor

size-limit report 📦

Path Size
react full 11.74 KB (0%)
react minimal 8.6 KB (0%)

@sukvvon
sukvvon merged commit 256abf4 into main Oct 18, 2026
9 checks passed
@sukvvon
sukvvon deleted the refactor/examples-react-rick-morty-query-options branch October 18, 2026 04:40
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