docs(svelte/testing): add the imports to the 'withEffectRoot' and fake timers examples so each can be used as its own file by sukvvon · Pull Request #12208 · TanStack/query

sukvvon · 2026-10-20T08:23:29Z

🎯 Changes

Add the missing imports to the withEffectRoot example (expect, it, vi, QueryClient, createQuery, and greetingOptions) and the fake timers example (render, afterEach, beforeEach, expect, it, vi, QueryClient, and GreetingTest) in docs/framework/svelte/testing.md, so each example compiles on its own.

✅ 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
- Updated testing documentation examples with the required imports for effect-root helpers and fake-timer component tests.
- Clarified examples involving testing utilities, Vitest APIs, query configuration, and greeting test components.

…e timers examples so each can be used as its own file

changeset-bot · 2026-10-20T08:23:39Z

⚠️ No Changeset found

Latest commit: d4513d9

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-20T08:25:01Z

View your CI Pipeline Execution ↗ for commit d4513d9

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

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

coderabbitai · 2026-10-20T08:25:51Z

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: 7e6b439c-db9b-468a-9e44-6d36b651449e

📥 Commits

Reviewing files that changed from the base of the PR and between 56432b4 and d4513d9.

📒 Files selected for processing: 1

docs/framework/svelte/testing.md

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 Svelte testing documentation now includes imports for the effect-root test helper example and the fake-timer component test example.

Changes: Svelte testing documentation

Layer / File(s)	Summary
Testing example imports `docs/framework/svelte/testing.md`	Added imports for the effect-root test helper and fake-timer component test examples.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to d4513

The documentation examples are correctly updated and introduce no actionable merge-blocking risk.

Pre-merge checks: 5

Check name	Status	Explanation
Title check		The title clearly identifies the documentation file and the missing imports added to the `withEffectRoot` and fake timers examples. It accurately summarizes the main change, although it is somewhat lo…
Description check		The description follows the required template. It explains the change and motivation, completes all checklist items, and identifies the change as docs-only with no release impact.
Docstring Coverage		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 0…
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: Title check

Explanation

The title clearly identifies the documentation file and the missing imports added to the withEffectRoot and fake timers examples. It accurately summarizes the main change, although it is somewhat long.

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 0 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches

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

github-actions · 2026-10-20T08:26:15Z

🚀 Changeset Version Preview

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

pkg-pr-new · 2026-10-20T08:28:35Z

More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: d4513d9

github-actions · 2026-10-20T08:28:42Z

size-limit report 📦

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

docs(svelte/testing): add the imports to the 'withEffectRoot' and fak…

d4513d9

…e timers examples so each can be used as its own file

sukvvon self-assigned this Oct 20, 2026

sukvvon merged commit bd427b9 into main Oct 20, 2026
9 checks passed

sukvvon deleted the docs/svelte-testing-snippet-imports branch October 20, 2026 10:58

Navigation Menu

Repository navigation

docs(svelte/testing): add the imports to the 'withEffectRoot' and fake timers examples so each can be used as its own file - #12208

docs(svelte/testing): add the imports to the 'withEffectRoot' and fake timers examples so each can be used as its own file#12208
sukvvon merged 1 commit into
mainfrom
docs/svelte-testing-snippet-imports

sukvvon commented Oct 20, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

changeset-bot Bot commented Oct 20, 2026

Uh oh!

nx-cloud Bot commented Oct 20, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Oct 20, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Oct 20, 2026

Uh oh!

pkg-pr-new Bot commented Oct 20, 2026

Uh oh!

github-actions Bot commented Oct 20, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

sukvvon commented Oct 20, 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 20, 2026

⚠️ No Changeset found

Uh oh!

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

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

github-actions Bot commented Oct 20, 2026

🚀 Changeset Version Preview

Uh oh!

pkg-pr-new Bot commented Oct 20, 2026

Uh oh!

github-actions Bot commented Oct 20, 2026

size-limit report 📦

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

sukvvon commented Oct 20, 2026 •

edited by coderabbitai Bot

Loading

nx-cloud Bot commented Oct 20, 2026 •

edited

Loading

coderabbitai Bot commented Oct 20, 2026 •

edited

Loading