Skip to content

fix(solid): cap solid-js peer range at ^1 - #203

Merged
KevinVandy merged 1 commit into
TanStack:mainfrom
ryansolid:solid-js-peer-cap
Oct 29, 2026
Merged

KevinVandy merged 1 commit into
TanStack:mainfrom
ryansolid:solid-js-peer-cap

Conversation

@ryansolid

@ryansolid ryansolid commented Oct 28, 2026 •

Copy link
Copy Markdown
Contributor

🎯 Changes

The Solid packages here declare an open-ended solid-js peer (>=1.x). Solid 2.0.0 is due shortly. Once it's tagged latest, that range will accept it, so npm install will pair these Solid 1 adapters with Solid 2 without any peer warning, and they will fail at build or run time: Solid 2 removes solid-js/store, createComputed, mergeProps/splitProps, onMount, batch and more.

This PR changes each range from >=X to ^X, keeping the same lower bound, and adds a patch changeset so the cap actually ships. Solid 2 support can then come as a new adapter major on a pre-release branch, the way @tanstack/solid-router 2.x and @tanstack/solid-query 6.x did it.

Prereleases (2.0.0-rc.*) never matched >=1.x, which is why nobody has run into this yet.

✅ Checklist

  • Only peerDependencies ranges and a changeset change; no code changes.

Summary by CodeRabbit

  • Compatibility
    • Updated the supported SolidJS peer dependency range for the hotkeys packages to Solid 1.x.

The open-ended >= range lets solid-js 2.0.0 satisfy the peer once it is
released, but these adapters are built for Solid 1.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0117BoWMMJ6aTSA3MvtgJWG2
@changeset-bot

changeset-bot Bot commented Oct 28, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: be81de5

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

This PR includes changesets to release 2 packages
Name Type
@tanstack/solid-hotkeys-devtools Patch
@tanstack/solid-hotkeys 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

@coderabbitai

coderabbitai Bot commented Oct 28, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
Commits

Reviewing files that changed from the base of the PR and between 41f06c5 and be81de5.

Files selected for processing: 3
  • .changeset/solid-js-peer-cap.md
  • packages/solid-hotkeys-devtools/package.json
  • packages/solid-hotkeys/package.json

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

Walkthrough

Both Solid hotkeys packages change their solid-js peer dependency range from >=1.7.0 to ^1.7.0. A changeset requests patch releases for both packages and describes the version cap.

Changes: Solid peer dependency range

Layer / File(s) Summary
Cap Solid peer dependency ranges
.changeset/solid-js-peer-cap.md, packages/solid-hotkeys-devtools/package.json, packages/solid-hotkeys/package.json
Both package manifests set the solid-js peer range to ^1.7.0. The changeset requests patch releases for both packages and describes the cap.

Priority: Normal

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

Change: Bug fix

Suggested reviewers: peyton-spencer

Merge Risk: Minimal · up to be81d

The dependency cap is correctly applied and the release metadata is complete; the change is mergeable.

Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed The title clearly and concisely describes the main change: limiting the solid-js peer dependency range to ^1.
Description check Passed The description clearly explains the motivation and implementation. It includes the Changes and Checklist sections and states that a changeset was added. The Release Impact section and two checklist i…
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: Description check

Explanation

The description clearly explains the motivation and implementation. It includes the Changes and Checklist sections and states that a changeset was added. The Release Impact section and two checklist items from the template are missing, but the description is otherwise mostly complete.

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

Finishing Touches
🧪 Generate unit tests (beta)
  • 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

A rabbit checks the range with care,
Solid one is listed there.
Two packages match the line,
Patch notes mark the release time.
Hop, the changeset joins the queue.

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

@KevinVandy
KevinVandy merged commit 7f99e69 into TanStack:main Oct 29, 2026
3 checks passed
@github-actions github-actions Bot mentioned this pull request Oct 29, 2026
@github-actions

Copy link
Copy Markdown
Contributor

🎉 This PR has been released!

Thank you for your contribution!

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.

2 participants