Skip to content

chore(query-devtools/tsdown.config): add '@refresh skip' banner so the app's 'solid-refresh' does not wrap the bundled Solid runtime - #12517

Merged
sukvvon merged 3 commits into
mainfrom
chore/query-devtools-refresh-skip
Nov 4, 2026
Merged

sukvvon merged 3 commits into
mainfrom
chore/query-devtools-refresh-skip

Conversation

@sukvvon

@sukvvon sukvvon commented Nov 4, 2026 •

Copy link
Copy Markdown
Member

🎯 Changes

Adds /* @refresh skip */ as a postBanner to every @tanstack/query-devtools build output.

@tanstack/query-devtools bundles its own Solid runtime (alwaysBundle: [/./]). When the package resolves outside node_modules (workspace links, pnpm link), vite-plugin-solid treats the prebuilt files as app source and solid-refresh wraps their components with the app's solid-js. The two runtimes then mix, and opening a page with the devtools in a SolidStart dev server throws Cannot read properties of undefined (reading 'sources').

@refresh skip is the directive solid-refresh provides to opt a file out. Installs from npm resolve inside node_modules, which the plugin already skips, so they are unaffected. Runtime code is unchanged; only the leading comment is added, and the sourcemaps account for the extra line.

✅ 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

  • Bug Fixes
    • Improved compatibility for Query Devtools in apps using Solid’s refresh tooling, helping the devtools runtime behave more reliably during development. This change applies to both development and production builds.

…e app's 'solid-refresh' does not wrap the bundled Solid runtime
@sukvvon sukvvon self-assigned this Nov 4, 2026
@changeset-bot

changeset-bot Bot commented Nov 4, 2026 •

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 4129ea1

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 24 packages
Name Type
@tanstack/query-devtools Patch
@tanstack/angular-query-experimental Patch
@tanstack/preact-query-devtools Patch
@tanstack/react-query-devtools Patch
@tanstack/solid-query-devtools Patch
@tanstack/svelte-query-devtools Patch
@tanstack/vue-query-devtools Patch
@tanstack/eslint-plugin-query Patch
@tanstack/preact-query-persist-client Patch
@tanstack/preact-query Patch
@tanstack/query-async-storage-persister Patch
@tanstack/query-broadcast-client-experimental Patch
@tanstack/query-core Patch
@tanstack/query-persist-client-core Patch
@tanstack/query-sync-storage-persister Patch
@tanstack/react-query-next-experimental Patch
@tanstack/react-query-persist-client Patch
@tanstack/react-query Patch
@tanstack/solid-query-persist-client Patch
@tanstack/solid-query Patch
@tanstack/vue-query Patch
@tanstack/svelte-query-persist-client Patch
@tanstack/svelte-query Patch
@tanstack/lit-query Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@nx-cloud

nx-cloud Bot commented Nov 4, 2026 •

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit 4129ea1

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

☁️ Nx Cloud last updated this comment at 2026-11-04 05:29:29 UTC

@github-actions

github-actions Bot commented Nov 4, 2026

Copy link
Copy Markdown
Contributor

🚀 Changeset Version Preview

5 package(s) bumped directly, 19 bumped as dependents.

🟩 Patch bumps

Package Version Reason
@tanstack/preact-query-devtools 5.105.3 → 5.105.4 Changeset
@tanstack/query-devtools 5.105.3 → 5.105.4 Changeset
@tanstack/react-query-devtools 5.105.3 → 5.105.4 Changeset
@tanstack/solid-query-devtools 5.105.3 → 5.105.4 Changeset
@tanstack/vue-query-devtools 6.3.9 → 6.3.10 Changeset
@tanstack/angular-query-experimental 5.105.3 → 5.105.4 Dependent
@tanstack/eslint-plugin-query 5.105.3 → 5.105.4 Dependent
@tanstack/lit-query 0.2.34 → 0.2.35 Dependent
@tanstack/preact-query 5.105.3 → 5.105.4 Dependent
@tanstack/preact-query-persist-client 5.105.3 → 5.105.4 Dependent
@tanstack/query-async-storage-persister 5.105.3 → 5.105.4 Dependent
@tanstack/query-broadcast-client-experimental 5.105.3 → 5.105.4 Dependent
@tanstack/query-core 5.105.3 → 5.105.4 Dependent
@tanstack/query-persist-client-core 5.105.3 → 5.105.4 Dependent
@tanstack/query-sync-storage-persister 5.105.3 → 5.105.4 Dependent
@tanstack/react-query 5.105.3 → 5.105.4 Dependent
@tanstack/react-query-next-experimental 5.105.3 → 5.105.4 Dependent
@tanstack/react-query-persist-client 5.105.3 → 5.105.4 Dependent
@tanstack/solid-query 5.105.3 → 5.105.4 Dependent
@tanstack/solid-query-persist-client 5.105.3 → 5.105.4 Dependent
@tanstack/svelte-query 6.3.9 → 6.3.10 Dependent
@tanstack/svelte-query-devtools 6.3.9 → 6.3.10 Dependent
@tanstack/svelte-query-persist-client 6.3.9 → 6.3.10 Dependent
@tanstack/vue-query 5.105.3 → 5.105.4 Dependent

@coderabbitai

coderabbitai Bot commented Nov 4, 2026 •

Copy link
Copy Markdown
Contributor

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The query devtools build configuration adds a /* @refresh skip */ post-build banner to production and development outputs. A patch changeset records the update.

Changes: Generated output banner

Layer / File(s) Summary
Add generated output banner
packages/query-devtools/tsdown.config.ts, .changeset/query-devtools-refresh-skip.md
The shared build configuration adds /* @refresh skip */ to output banners. A patch changeset records the change.

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

Change: Bug fix

Possibly related PRs

  • TanStack/query#12423: Adds Solid applications that use @tanstack/solid-query-devtools, which depends on @tanstack/query-devtools.
  • TanStack/query#12483: Adds Solid applications that use @tanstack/solid-query-devtools, including a refresh-enabled entry point.
  • TanStack/query#12507: Adds a SolidStart integration that imports @tanstack/solid-query-devtools.

Suggested reviewers: tkdodo

Merge Risk: Minimal · up to 4129e

The change opts generated devtools files out of Solid refresh without changing runtime logic. No actionable merge-blocking risk is identified.

Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed The title clearly identifies the affected package, configuration file, and purpose of the change. It is specific and directly matches the main changeset and build configuration updates.
Description check Passed The description follows the required template. It explains the change and motivation, completes the checklist, and records the changeset for the published-code change.
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
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 eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 1 files. (1 skipped: 1 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
Recent review info
Run configuration
Commits

Reviewing files that changed from the base of the PR and between d5781a4 and 4129ea1.

Files selected for processing: 2
  • .changeset/query-devtools-refresh-skip.md
  • packages/query-devtools/tsdown.config.ts

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

@pkg-pr-new

pkg-pr-new Bot commented Nov 4, 2026

Copy link
Copy Markdown
More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 4129ea1

@github-actions

github-actions Bot commented Nov 4, 2026

Copy link
Copy Markdown
Contributor

size-limit report 📦

Path Size
react full 11.84 KB (0%)
react minimal 8.66 KB (0%)

@sukvvon
sukvvon merged commit 1176d37 into main Nov 4, 2026
9 checks passed
@sukvvon
sukvvon deleted the chore/query-devtools-refresh-skip branch November 4, 2026 05:29
@github-actions github-actions Bot mentioned this pull request Nov 4, 2026
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