chore(tanstack-start): Add deprecation warning for package renaming #5327
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
🦋 Changeset detectedLatest commit: 9ab2607 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
wobsoriano
changed the title
.changeset/cuddly-cups-sip.md
Outdated
| '@clerk/tanstack-start': patch | ||
| --- | ||
|
|
||
| Added a warning message to help prepare for an upcoming package rename. We'll be changing from `@clerk/tanstack-start` to `@clerk/tanstack-react-start` in the next minor version to better align with TanStack Start's new package naming convention. No newline at end of file |
There was a problem hiding this comment.
I think we should rename the package now before the stable release to take advantage of the beta period flexibility
…-package-renaming
|
|
||
| export const warnPackageRenaming = () => { | ||
| console.warn( | ||
| '[@clerk/tanstack-start] Warning: This package will be renamed to @clerk/tanstack-react-start in the next minor version. Please stay tuned for the release to update your imports accordingly.', |
There was a problem hiding this comment.
I don't like that this is not actionable for a user. Here's what I had in mind:
- Rename the package locally and bump the minor
- Publish this new package locally so that it exists on npm
- Add this warning here with actionable steps for people to migrate (this also includes changing the README of this package
- Publish it
- Rename the package in this repo here
This way people can immediately migrate without having to wait
There was a problem hiding this comment.
Thanks for sharing your idea! I like this, and we just published a snapshot of @clerk/tanstack-react-start to NPM. We can proceed with the updated warning message 🫡
There was a problem hiding this comment.
After this gets merged and published, I'll open this PR that will add @clerk/tanstack-start to ignored packages of changesets
wobsoriano
changed the title
…-package-renaming
wobsoriano
deleted the
rob/eco-502-add-message-warning-for-upcoming-package-renaming
branch
Description
TanStack Router/Start has renamed its packages from
@tanstack/routerand@tanstack/startto@tanstack/react-routerand@tanstack/react-startfollowing the release of their Solid.js (@tanstack/solid-router) package.We have already migrated internally to using
@tanstack/react-starthere, but to avoid potential confusion, we'd also like to rename our package to@clerk/tanstack-react-startto clearly indicate that this is specifically for the React package.Resolves ECO-502
Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change