Skip to content

docs(lit): remove '@tanstack/query-core' and 'lit' from the install commands to install only '@tanstack/lit-query' - #12209

Draft
sukvvon wants to merge 3 commits into
mainfrom
docs/lit-install-without-query-core
Draft

sukvvon wants to merge 3 commits into
mainfrom
docs/lit-install-without-query-core

Conversation

@sukvvon

@sukvvon sukvvon commented Oct 20, 2026 •

Copy link
Copy Markdown
Member

🎯 Changes

  • Update the install commands in docs/framework/lit/installation.md and packages/lit-query/README.md to install only @tanstack/lit-query.
  • Remove the note asking apps to install @tanstack/query-core explicitly as a peer dependency.

✅ 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).

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

changeset-bot Bot commented Oct 20, 2026 •

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 4554cba

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

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit 4554cba

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

☁️ Nx Cloud last updated this comment at 2026-10-20 11:56:07 UTC

@sukvvon
sukvvon marked this pull request as draft October 20, 2026 11:18
@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 20, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Important

Draft PR not reviewed

Draft PRs are not automatically reviewed by default.

  • Trigger a manual review

To automatically review draft PRs, update your CodeRabbit configuration:

reviews:
  auto_review:
    drafts: true

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: 878f37d6-7494-4dc7-89ed-be89991f966c
📥 Commits

Reviewing files that changed from the base of the PR and between 67eaf77 and bc64ac9.

📒 Files selected for processing: 2
  • docs/framework/lit/installation.md
  • packages/lit-query/README.md

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 Lit installation guide and package README update their install commands to omit the explicit @tanstack/query-core dependency. The guide also removes its peer-dependency explanation.

Changes: Lit installation instructions

Layer / File(s) Summary
Update installation commands
docs/framework/lit/installation.md, packages/lit-query/README.md
The installation guide’s npm, pnpm, yarn, and Bun commands and the README install command omit @tanstack/query-core. The guide also removes the peer-dependency explanation.

Priority: ⬇️ Low

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

Change: Other

Suggested reviewers: chughgaurav

Merge Risk: ⚪ Minimal · up to bc64a

The installation instructions can merge with normal checks; no actionable installation issue is established.

Pre-merge checks: Passed 4 · Failed 1

Failed Failed checks: 1 warning

Check name Status Explanation Resolution
Title check Warning The title is misleading because it says the install commands remove both '@tanstack/query-core' and 'lit', but the changes retain 'lit' and remove only the explicit '@tanstack/query-core' dependency. Update the title to state that the commands remove the explicit '@tanstack/query-core' dependency while retaining 'lit', for example: "docs(lit): remove explicit query-core dependency from install commands".
Passed Passed checks: 4 passed
Check name Status Explanation
Docstring Coverage Passed 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 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.
Description check Passed The description clearly lists the documentation changes, checklist status, testing statement, AI policy confirmation, and docs-only release impact.
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. (2 skipped: 2 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.

@pkg-pr-new

pkg-pr-new Bot commented Oct 20, 2026 •

Copy link
Copy Markdown
More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 4554cba

@github-actions

Copy link
Copy Markdown
Contributor

size-limit report 📦

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

@sukvvon sukvvon changed the title docs(lit): remove '@tanstack/query-core' from the install commands since 'lit-query' already depends on it docs(lit): remove '@tanstack/query-core' and 'lit' from the install commands to install only '@tanstack/lit-query' Oct 20, 2026

This branch has not been deployed

No deployments
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