chore(remix): Add deprecation warning for maintenance mode #6744

wobsoriano · 2025-09-09T22:41:16Z

Description

Adds a deprecation warning to the @clerk/remix package to inform users that it's now in maintenance mode and will only receive security updates. Remix itself is in maintenance mode and only receives security updates.

The original Remix authors are working on a new "Remix" package that is not React-based, and may confuse future developers using the @clerk/remix package.

Checklist

pnpm test runs as expected.
pnpm build runs as expected.
(If applicable) JSDoc comments have been added or updated for any package exports
(If applicable) Documentation has been updated

Type of change

Summary by CodeRabbit

Documentation
- Announced maintenance mode for the Remix SDK and provided migration guidance to @clerk/react-router with links to the Remix upgrade guide and Clerk’s React Router docs.
Chores
- Added a one-time deprecation warning at runtime when the Remix SDK is imported.
- Added a changeset to publish a minor release highlighting the deprecation.
- No public API changes.

changeset-bot · 2025-09-09T22:41:20Z

🦋 Changeset detected

Latest commit: 84cd67b

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

This PR includes changesets to release 1 package

Name	Type
@clerk/remix	Minor

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

vercel · 2025-09-09T22:41:21Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
clerk-js-sandbox	Ready	Preview	Comment	Sep 9, 2025 10:43pm

coderabbitai · 2025-09-09T22:41:23Z

Walkthrough

Introduces a maintenance-mode deprecation notice for the Remix package. On module import, it logs a one-time warning directing users to migrate to @clerk/react-router, with links. Adds a changeset entry for a minor version update and migration guidance. No public APIs changed.

Changes

Cohort / File(s)	Summary
Release notes / Changeset `\.changeset/eleven-timers-clean.md`	Adds a changeset declaring a minor bump for @clerk/remix and deprecation/maintenance-mode notice with migration links to @clerk/react-router.
Runtime init / Deprecation logging `packages/remix/src/index.ts`	Adds import-time side-effect: initializes shared logger and emits a warnOnce deprecation message for Remix, then continues existing exports from `./client`. No API/signature changes.

Sequence Diagram(s)

sequenceDiagram
    autonumber
    participant App as App (Importer)
    participant Remix as packages/remix/src/index.ts
    participant Logger as Logger

    App->>Remix: import '@clerk/remix'
    activate Remix
    Remix->>Logger: warnOnce("Remix in maintenance mode... migrate to @clerk/react-router")
    note right of Logger: One-time deprecation warning on first import
    Remix-->>App: export * from './client'
    deactivate Remix

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Pre-merge checks (3 passed)

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title succinctly and accurately highlights the primary change—adding a deprecation warning for maintenance mode in the @clerk/remix package—using clear and concise language without extraneous details.
Description Check	✅ Passed	The description directly relates to the changeset by detailing the added deprecation warning, explaining the maintenance‐mode status, and providing context about the upstream Remix project, making it clearly relevant to the changes.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

Poem

I thump my paws—“A gentle nudge!”
A warning squeaks with courteous fudge.
Remix naps in maintenance light,
React Router hops into sight.
Version bumps with tidy cheer—
Onward we bound, with logs to steer. 🐇✨

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch rob/deprecation-warning-remix

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

pkg-pr-new · 2025-09-09T22:45:30Z

Open in StackBlitz

@clerk/agent-toolkit

npm i https://pkg.pr.new/@clerk/agent-toolkit@6744

@clerk/astro

npm i https://pkg.pr.new/@clerk/astro@6744

@clerk/backend

npm i https://pkg.pr.new/@clerk/backend@6744

@clerk/chrome-extension

npm i https://pkg.pr.new/@clerk/chrome-extension@6744

@clerk/clerk-js

npm i https://pkg.pr.new/@clerk/clerk-js@6744

@clerk/dev-cli

npm i https://pkg.pr.new/@clerk/dev-cli@6744

@clerk/elements

npm i https://pkg.pr.new/@clerk/elements@6744

@clerk/clerk-expo

npm i https://pkg.pr.new/@clerk/clerk-expo@6744

@clerk/expo-passkeys

npm i https://pkg.pr.new/@clerk/expo-passkeys@6744

@clerk/express

npm i https://pkg.pr.new/@clerk/express@6744

@clerk/fastify

npm i https://pkg.pr.new/@clerk/fastify@6744

@clerk/localizations

npm i https://pkg.pr.new/@clerk/localizations@6744

@clerk/nextjs

npm i https://pkg.pr.new/@clerk/nextjs@6744

@clerk/nuxt

npm i https://pkg.pr.new/@clerk/nuxt@6744

@clerk/clerk-react

npm i https://pkg.pr.new/@clerk/clerk-react@6744

@clerk/react-router

npm i https://pkg.pr.new/@clerk/react-router@6744

@clerk/remix

npm i https://pkg.pr.new/@clerk/remix@6744

@clerk/shared

npm i https://pkg.pr.new/@clerk/shared@6744

@clerk/tanstack-react-start

npm i https://pkg.pr.new/@clerk/tanstack-react-start@6744

@clerk/testing

npm i https://pkg.pr.new/@clerk/testing@6744

@clerk/themes

npm i https://pkg.pr.new/@clerk/themes@6744

@clerk/types

npm i https://pkg.pr.new/@clerk/types@6744

@clerk/upgrade

npm i https://pkg.pr.new/@clerk/upgrade@6744

@clerk/vue

npm i https://pkg.pr.new/@clerk/vue@6744

commit: 84cd67b

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (5)

.changeset/eleven-timers-clean.md (2)
7-8: Fix markdownlint MD034 (no-bare-urls).

Wrap the URLs in angle brackets or convert to link syntax to satisfy markdownlint.
-Migration guide: https://reactrouter.com/upgrading/remix
-React Router SDK: https://clerk.com/docs/quickstarts/react-router
+Migration guide: <https://reactrouter.com/upgrading/remix>
+React Router SDK: <https://clerk.com/docs/quickstarts/react-router>
1-6: Changeset content looks good. Consider whether this warrants patch vs. minor.

Since this is a runtime warning with no API change, a patch bump may also be appropriate. If your release policy prefers minor for deprecation messaging, ignore.
packages/remix/src/index.ts (3)
3-15: Gate the deprecation warning to dev/test to avoid production log noise.

This runs on every import (server and browser). Suggest gating to dev/test and allowing opt-out via env.
-import { logger } from '@clerk/shared/logger';
-
-logger.warnOnce(`
+import { logger } from '@clerk/shared/logger';
+
+if (process.env.NODE_ENV !== 'production' && process.env.CLERK_SDK_WARNINGS !== 'false') {
+  logger.warnOnce(`
 Clerk - DEPRECATION WARNING: @clerk/remix is now in maintenance mode.
 
 @clerk/remix will only receive security updates. No new features will be added.
 
 Please migrate to @clerk/react-router for continued development and new features:
 
 Migration guide: https://reactrouter.com/upgrading/remix
 React Router SDK: https://clerk.com/docs/quickstarts/react-router
-`);
+  `);
+}
5-14: Tune copy to align with official guidance and avoid implying “Remix itself” is in maintenance mode.

React Router v7 is positioned as the next major version after Remix v2; the “Wake up, Remix!” post outlines a new (non-React) direction for Remix v3. Suggest clarifying the message to focus on this package’s maintenance status and direct users to the upgrade guide.
-logger.warnOnce(`
-Clerk - DEPRECATION WARNING: @clerk/remix is now in maintenance mode.
-
-@clerk/remix will only receive security updates. No new features will be added.
-
-Please migrate to @clerk/react-router for continued development and new features:
-
-Migration guide: https://reactrouter.com/upgrading/remix
-React Router SDK: https://clerk.com/docs/quickstarts/react-router
-`);
+logger.warnOnce(`
+Clerk - NOTICE: The @clerk/remix package is now in maintenance mode and will only receive security updates.
+
+For ongoing feature development, migrate to @clerk/react-router. React Router v7 is the evolution of Remix v2.
+
+Upgrade guide: https://reactrouter.com/upgrading/remix
+Clerk React Router SDK: https://clerk.com/docs/quickstarts/react-router
+`);
Reference: “Upgrading from Remix” (React Router v7 is the next major version after v2). (reactrouter.com)

Context: “Wake up, Remix!” outlines Remix v3’s direction (not React-dependent). (remix.run)

3-3: Sanity check: confirm logger.warnOnce dedupes across both server and client bundles.

If warnOnce de-dupes per process only, users may still see one log on server and one in the browser. That’s acceptable, but confirm intent.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 7fe00d6 and 84cd67b.

📒 Files selected for processing (2)

.changeset/eleven-timers-clean.md (1 hunks)
packages/remix/src/index.ts (1 hunks)

🧰 Additional context used

📓 Path-based instructions (9)

.changeset/**

📄 CodeRabbit inference engine (.cursor/rules/monorepo.mdc)

Automated releases must use Changesets.

Files:

.changeset/eleven-timers-clean.md

**/*.{js,jsx,ts,tsx}