Skip to content

Conversation

@dstaley
Copy link
Member

@dstaley dstaley commented Nov 18, 2025

Description

This PR updates the @clerk/remix README with a deprecation notice.

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

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

Summary by CodeRabbit

  • Documentation

    • README updated with a deprecation notice and migration guidance for the recommended router integration.
    • Minor formatting tweaks in several READMEs for clearer spacing.
  • Chores

    • Development tooling dependency bumped to a newer version.
    • Added release metadata file.
  • Style

    • Non-functional formatting adjustments in compiled/shared code to standardize expression wrapping.

@changeset-bot
Copy link

changeset-bot bot commented Nov 18, 2025

🦋 Changeset detected

Latest commit: aa00010

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

This PR includes changesets to release 0 packages

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

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
Copy link

vercel bot commented Nov 18, 2025

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

Project Deployment Preview Comments Updated (UTC)
clerk-js-sandbox Ready Ready Preview Comment Nov 18, 2025 6:58pm

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 18, 2025

Walkthrough

Adds an empty changeset marker file, deprecates @clerk/remix in packages/remix/README.md and directs Remix v3 users to @clerk/react-router, bumps prettier in package.json, and applies minor formatting/parenthesis-only edits in several README files and a compiled path-to-regexp file.

Changes

Cohort / File(s) Summary
Changeset marker
\.changeset/fruity-clocks-send.md
New changeset file added containing only YAML front-matter delimiters and no other content.
Remix README (deprecation)
packages/remix/README.md
Updated README text to deprecate @clerk/remix and instruct users upgrading to Remix v3 to use @clerk/react-router; content-only change.
Documentation formatting
integration/README.md, packages/localizations/README.md
Minor whitespace/formatting edits (removed empty lines) in README files; no behavioral changes.
Dependency bump
package.json
Bumps prettier dependency from ^3.5.3 to ^3.6.2. No other functional changes.
Compiled formatting edits
packages/shared/src/compiled/path-to-regexp/index.js
Superficial parenthesis and formatting adjustments around n.push(...) and related expressions; no logic or API changes.

Sequence Diagram(s)

(omitted — changes are documentation, formatting, and a dependency version bump; no control-flow or feature behavior changed)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

  • Check packages/remix/README.md wording and links for accuracy.
  • Confirm \.changeset/fruity-clocks-send.md being intentionally empty.
  • Glance at packages/shared/src/compiled/path-to-regexp/index.js to ensure formatting edits didn't alter runtime expressions.
  • Verify prettier bump doesn't introduce required repo-wide formatting changes.

Poem

🐇 I hopped through files, left a tiny dot,
A README now whispers of a newer plot.
Prettier leapt a version, tidy and quick,
Parentheses danced — a formatting trick.
Nibble on changes, then off with a hop — that's my lot. 🥕

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 25.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: adding a deprecation notice to the @clerk/remix package as reflected in the README updates.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch ds.chore/deprecate-remix

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

  • 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 252b9a2 and aa00010.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (3)
  • integration/README.md (0 hunks)
  • packages/localizations/README.md (0 hunks)
  • packages/shared/src/compiled/path-to-regexp/index.js (6 hunks)
💤 Files with no reviewable changes (2)
  • packages/localizations/README.md
  • integration/README.md
✅ Files skipped from review due to trivial changes (1)
  • packages/shared/src/compiled/path-to-regexp/index.js
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (15)
  • GitHub Check: Integration Tests (quickstart, chrome, 15)
  • GitHub Check: Integration Tests (nextjs, chrome, 16)
  • GitHub Check: Integration Tests (nextjs, chrome, 15, RQ)
  • GitHub Check: Integration Tests (billing, chrome, RQ)
  • GitHub Check: Integration Tests (nextjs, chrome, 14)
  • GitHub Check: Integration Tests (nextjs, chrome, 15)
  • GitHub Check: Integration Tests (custom, chrome)
  • GitHub Check: Integration Tests (sessions:staging, chrome)
  • GitHub Check: Integration Tests (billing, chrome)
  • GitHub Check: Integration Tests (generic, chrome)
  • GitHub Check: Integration Tests (astro, chrome)
  • GitHub Check: Integration Tests (machine, chrome)
  • GitHub Check: Integration Tests (localhost, chrome)
  • GitHub Check: Integration Tests (elements, chrome)
  • GitHub Check: Integration Tests (sessions, chrome)

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

Copy link
Member

@wobsoriano wobsoriano left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👋🏼

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

  • 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 66fdeb4 and 2c0e331.

📒 Files selected for processing (2)
  • .changeset/fruity-clocks-send.md (1 hunks)
  • packages/remix/README.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (33)
  • GitHub Check: Integration Tests (nuxt, chrome)
  • GitHub Check: Integration Tests (nextjs, chrome, 16)
  • GitHub Check: Integration Tests (nextjs, chrome, 15)
  • GitHub Check: Integration Tests (quickstart, chrome, 15)
  • GitHub Check: Integration Tests (handshake:staging, chrome)
  • GitHub Check: Integration Tests (nextjs, chrome, 14)
  • GitHub Check: Integration Tests (nextjs, chrome, 15, RQ)
  • GitHub Check: Integration Tests (quickstart, chrome, 16)
  • GitHub Check: Integration Tests (elements, chrome)
  • GitHub Check: Integration Tests (vue, chrome)
  • GitHub Check: Integration Tests (billing, chrome, RQ)
  • GitHub Check: Integration Tests (react-router, chrome)
  • GitHub Check: Integration Tests (astro, chrome)
  • GitHub Check: Integration Tests (express, chrome)
  • GitHub Check: Integration Tests (sessions:staging, chrome)
  • GitHub Check: Integration Tests (billing, chrome)
  • GitHub Check: Integration Tests (localhost, chrome)
  • GitHub Check: Integration Tests (sessions, chrome)
  • GitHub Check: Integration Tests (custom, chrome)
  • GitHub Check: Integration Tests (expo-web, chrome)
  • GitHub Check: Integration Tests (tanstack-react-start, chrome)
  • GitHub Check: Integration Tests (machine, chrome)
  • GitHub Check: Integration Tests (generic, chrome)
  • GitHub Check: Integration Tests (handshake, chrome)
  • GitHub Check: Integration Tests (ap-flows, chrome)
  • GitHub Check: Unit Tests (22, shared, clerk-js, RQ)
  • GitHub Check: Publish with pkg-pr-new
  • GitHub Check: Unit Tests (22, **)
  • GitHub Check: Static analysis
  • GitHub Check: Formatting | Dedupe | Changeset
  • GitHub Check: semgrep-cloud-platform/scan
  • GitHub Check: semgrep-cloud-platform/scan
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (1)
packages/remix/README.md (1)

28-28: Deprecation notice is clear and well-positioned.

The warning effectively communicates the package's deprecation status, directs users to the replacement package (@clerk/react-router), and specifies the relevant upgrade/migration scenarios. Placement at the top of the README ensures visibility.

Comment on lines +1 to +2
---
---
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

Changeset file is incomplete—add required metadata.

The changeset file is missing the package name and version bump type between the YAML delimiters. This is required for the changeset tooling to function correctly.

Apply this diff to add the required metadata:

 ---
+@clerk/remix: patch
 ---
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
---
---
---
@clerk/remix: patch
---
🤖 Prompt for AI Agents
In .changeset/fruity-clocks-send.md around lines 1 to 2 the changeset YAML block
is empty and missing required metadata (package name and release type). Edit the
file to add the package identifier(s) and the bump type (patch/minor/major)
inside the YAML delimiters, and include an optional summary below the block;
ensure the YAML follows changeset format (package-name: patch) so the tooling
can parse it.

@pkg-pr-new
Copy link

pkg-pr-new bot commented Nov 18, 2025

Open in StackBlitz

@clerk/agent-toolkit

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

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/elements

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

@clerk/clerk-expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/clerk-react

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

@clerk/react-router

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

@clerk/remix

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/themes

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

@clerk/types

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

@clerk/upgrade

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

@clerk/vue

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

commit: aa00010

@dstaley dstaley merged commit edbd18c into main Nov 18, 2025
47 checks passed
@dstaley dstaley deleted the ds.chore/deprecate-remix branch November 18, 2025 19:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants