Skip to content

chore(solid-query-devtools/tsconfig): include 'test-setup.ts' for jest-dom matcher typings#10845

Merged
sukvvon merged 1 commit into
mainfrom
chore/solid-query-devtools-tsconfig-include-test-setup
May 31, 2026
Merged

chore(solid-query-devtools/tsconfig): include 'test-setup.ts' for jest-dom matcher typings#10845
sukvvon merged 1 commit into
mainfrom
chore/solid-query-devtools-tsconfig-include-test-setup

Conversation

@sukvvon
Copy link
Copy Markdown
Collaborator

@sukvvon sukvvon commented May 31, 2026

🎯 Changes

Add "test-setup.ts" to the include array in packages/solid-query-devtools/tsconfig.json so the @testing-library/jest-dom/vitest type augmentation is picked up by the TypeScript compiler.

Today, the file is loaded at runtime via vite.config.ts's test.setupFiles, so jest-dom matchers work in tests. However, because the file is not part of the TypeScript project, matchers like toHaveStyle, toBeInTheDocument, and toHaveClass are not recognized by the type checker and require workarounds such as as HTMLElement casts.

All other devtools/query packages that use a test-setup.ts already include it in their tsconfig (query-devtools, react-query-devtools, preact-query-devtools, solid-query, react-query, preact-query, etc.). This brings solid-query-devtools in line with that convention.

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested this code locally with `pnpm run test:pr`.

🚀 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

  • Chores
    • Reformatted build configuration for improved organization and readability.
    • Updated the build/include paths to incorporate additional test setup so tests are discovered during runs.
    • No changes to public APIs or exported interfaces; no user-facing behavior altered.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 31, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: ddf04b57-4e27-4929-8223-3ebff3a4f4f4

📥 Commits

Reviewing files that changed from the base of the PR and between 1b96424 and 7dfda98.

📒 Files selected for processing (1)
  • packages/solid-query-devtools/tsconfig.json
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/solid-query-devtools/tsconfig.json

📝 Walkthrough

Walkthrough

Reformats packages/solid-query-devtools/tsconfig.json include from a single-line array to a multi-line array and adds test-setup.ts to the included paths while preserving src, *.config.ts, *.config.js, and package.json.

Changes

Configuration formatting

Layer / File(s) Summary
TypeScript config include formatting
packages/solid-query-devtools/tsconfig.json
The include array is expanded from a compact single-line format into a multi-line structure, explicitly listing src, test-setup.ts, *.config.ts, *.config.js, and package.json.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • TanStack/query#10678: Also adjusts tsconfig.json include formatting and adds test-setup.ts in a related package.

Suggested labels

package: query-devtools

Poem

🐰 I hopped through JSON, tidy and bright,

Added a file, gave the paths more light.
Multi-line dancing, commas in place,
TypeScript smiles with clearer space.
A small config hop — neat code, soft pace.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly describes the main change: adding 'test-setup.ts' to tsconfig.json's include array for jest-dom type augmentation in solid-query-devtools.
Description check ✅ Passed The description comprehensively covers all required template sections with detailed context about the change, motivation, testing, and release impact classification.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/solid-query-devtools-tsconfig-include-test-setup

Comment @coderabbitai help to get the list of available commands and usage tips.

@nx-cloud
Copy link
Copy Markdown

nx-cloud Bot commented May 31, 2026

View your CI Pipeline Execution ↗ for commit 1b96424

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

☁️ Nx Cloud last updated this comment at 2026-05-31 15:41:27 UTC

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 31, 2026

🚀 Changeset Version Preview

2 package(s) bumped directly, 23 bumped as dependents.

🟩 Patch bumps

Package Version Reason
@tanstack/lit-query 0.2.6 → 0.2.7 Changeset
@tanstack/query-devtools 5.100.14 → 5.100.15 Changeset
@tanstack/angular-query-experimental 5.100.14 → 5.100.15 Dependent
@tanstack/angular-query-persist-client 5.100.14 → 5.100.15 Dependent
@tanstack/eslint-plugin-query 5.100.14 → 5.100.15 Dependent
@tanstack/preact-query 5.100.14 → 5.100.15 Dependent
@tanstack/preact-query-devtools 5.100.14 → 5.100.15 Dependent
@tanstack/preact-query-persist-client 5.100.14 → 5.100.15 Dependent
@tanstack/query-async-storage-persister 5.100.14 → 5.100.15 Dependent
@tanstack/query-broadcast-client-experimental 5.100.14 → 5.100.15 Dependent
@tanstack/query-core 5.100.14 → 5.100.15 Dependent
@tanstack/query-persist-client-core 5.100.14 → 5.100.15 Dependent
@tanstack/query-sync-storage-persister 5.100.14 → 5.100.15 Dependent
@tanstack/react-query 5.100.14 → 5.100.15 Dependent
@tanstack/react-query-devtools 5.100.14 → 5.100.15 Dependent
@tanstack/react-query-next-experimental 5.100.14 → 5.100.15 Dependent
@tanstack/react-query-persist-client 5.100.14 → 5.100.15 Dependent
@tanstack/solid-query 5.100.14 → 5.100.15 Dependent
@tanstack/solid-query-devtools 5.100.14 → 5.100.15 Dependent
@tanstack/solid-query-persist-client 5.100.14 → 5.100.15 Dependent
@tanstack/svelte-query 6.1.33 → 6.1.34 Dependent
@tanstack/svelte-query-devtools 6.1.33 → 6.1.34 Dependent
@tanstack/svelte-query-persist-client 6.1.33 → 6.1.34 Dependent
@tanstack/vue-query 5.100.14 → 5.100.15 Dependent
@tanstack/vue-query-devtools 6.1.33 → 6.1.34 Dependent

@sukvvon sukvvon self-assigned this May 31, 2026
@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented May 31, 2026

More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 7dfda98

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 31, 2026

size-limit report 📦

Path Size
react full 12.11 KB (0%)
react minimal 9.08 KB (0%)

@sukvvon sukvvon force-pushed the chore/solid-query-devtools-tsconfig-include-test-setup branch from 1b96424 to 7dfda98 Compare May 31, 2026 15:39
@sukvvon sukvvon changed the title chore(solid-query-devtools/tsconfig): include 'test-setup.ts' to align with other packages chore(solid-query-devtools/tsconfig): include 'test-setup.ts' for jest-dom matcher typings May 31, 2026
@sukvvon sukvvon merged commit dccede4 into main May 31, 2026
9 checks passed
@sukvvon sukvvon deleted the chore/solid-query-devtools-tsconfig-include-test-setup branch May 31, 2026 15:42
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