Skip to content

docs(integrations): describe what each integration checks in its README - #12622

Merged
sukvvon merged 1 commit into
mainfrom
docs/integrations-readmes
Nov 18, 2026
Merged

sukvvon merged 1 commit into
mainfrom
docs/integrations-readmes

Conversation

@sukvvon

@sukvvon sukvvon commented Nov 18, 2026 •

Copy link
Copy Markdown
Member

🎯 Changes

Adds a README to each of the 22 integrations describing what it checks. Only 4 had one before, and those were the boilerplate generated by create-next-app (react/next-14, react/next-15, react/next-16) and the Angular CLI (angular/cli-22).

Each README has:

  • a one-sentence summary of what the integration checks (which adapter packages, and with which framework, bundler, or TypeScript setup);
  • a "What it checks" list naming the files and settings it exercises, and the scripts CI runs (build and/or test:types);
  • the pnpm nx run commands to run those targets from the repository root.

✅ 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
    • Added integration guides covering supported framework and tooling combinations across Angular, React, Vue, Solid, Svelte, Lit, and Preact.
    • Documented how to run build and type-check validations locally, along with the checks performed in CI.
    • Replaced generic starter guidance with integration-specific build and compatibility details where applicable.

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

changeset-bot Bot commented Nov 18, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 240177e

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

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit 240177e

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

☁️ Nx Cloud last updated this comment at 2026-11-18 08:35:51 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 Nov 18, 2026 •

Copy link
Copy Markdown
Contributor

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The changes replace or add integration READMEs. They document integration coverage, configuration, CI scripts, and commands to run checks from the repository root.

Changes: Integration documentation

Layer / File(s) Summary
Angular integrations
integrations/angular/cli-22/README.md, integrations/angular/types-*/README.md
Documents the Angular CLI build integration and Angular 20, 21, and 22 type-check integrations, including configurations and run commands.
React integrations
integrations/react/next-*/README.md, integrations/react/nodenext/README.md, integrations/react/vite/README.md, integrations/react/webpack-*/README.md
Documents integration checks for Next.js, NodeNext, Vite, and webpack, along with their configurations, CI scripts, and commands.
Lit, Preact, Solid, and Svelte integrations
integrations/lit/vite/README.md, integrations/preact/vite/README.md, integrations/solid/*/README.md, integrations/svelte/*/README.md
Documents integration examples, build and type-check coverage, CI scripts, and commands.
Vue integrations
integrations/vue/declaration-emit/README.md, integrations/vue/nuxt-*/README.md, integrations/vue/vite/README.md
Documents declaration-emission, Nuxt, and Vite integration checks, their configurations, and run commands.

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

Change: Other

Possibly related PRs

  • TanStack/query#12506: Creates the Angular CLI 22 integration whose configuration and build checks are documented in this change.

Suggested reviewers: tkdodo

Merge Risk: Minimal · up to 24017

This change only updates integration READMEs to describe what each integration checks and how to run it. It does not touch runtime code, so merge risk is minimal.

Pre-merge checks: Passed 4

Check name Status Explanation
Title check Passed The title "docs(integrations): describe what each integration checks in its README" matches the main change. The PR adds a README to each of the 22 integrations that describes what the integration che…
Description check Passed The description follows the repository template. It has a Changes section that explains what was added and why (each integration had no README or only boilerplate). It lists what each README contains …
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: Title check

Explanation

The title "docs(integrations): describe what each integration checks in its README" matches the main change. The PR adds a README to each of the 22 integrations that describes what the integration checks. The title uses a conventional-commit style prefix and names the scope and purpose, so a reviewer scanning history can identify the primary change.

Full details: Description check

Explanation

The description follows the repository template. It has a Changes section that explains what was added and why (each integration had no README or only boilerplate). It lists what each README contains and the commands to run them. The checklist is completed. The release impact section marks the change as docs/CI/dev-only, which matches the objectives. The template asks for a changeset only for published code, so none is needed here. The description is mostly complete and specific.

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

Recent review info

Run configuration

Commits

Reviewing files that changed from the base of the PR and between 7ed5ea9 and 240177e.

Files selected for processing: 22

  • integrations/angular/cli-22/README.md
  • integrations/angular/types-20/README.md
  • integrations/angular/types-21/README.md
  • integrations/angular/types-22/README.md
  • integrations/lit/vite/README.md
  • integrations/preact/vite/README.md
  • integrations/react/next-14/README.md
  • integrations/react/next-15/README.md
  • integrations/react/next-16/README.md
  • integrations/react/nodenext/README.md
  • integrations/react/vite/README.md
  • integrations/react/webpack-4/README.md
  • integrations/react/webpack-5/README.md
  • integrations/solid/astro-7/README.md
  • integrations/solid/solid-start-2/README.md
  • integrations/solid/vite/README.md
  • integrations/svelte/sveltekit-2/README.md
  • integrations/svelte/vite/README.md
  • integrations/vue/declaration-emit/README.md
  • integrations/vue/nuxt-3/README.md
  • integrations/vue/nuxt-4/README.md
  • integrations/vue/vite/README.md

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

Copy link
Copy Markdown
More templates

@tanstack/angular-query

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

@tanstack/angular-query-devtools

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

@tanstack/angular-query-persist-client

npm i https://pkg.pr.new/@tanstack/angular-query-persist-client@12622

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 240177e

@github-actions

Copy link
Copy Markdown
Contributor

size-limit report 📦

Path Size
react full 11.85 KB (0%)
react minimal 8.68 KB (0%)

@sukvvon
sukvvon merged commit 08c09b4 into main Nov 18, 2026
9 checks passed
@sukvvon
sukvvon deleted the docs/integrations-readmes branch November 18, 2026 09:54
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