Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(clerk-js): Throw error if routing options are used incorrectly #2208

Conversation

octoper
Copy link
Member

@octoper octoper commented Nov 24, 2023

Description

This PR introduces a breaking change for all the components using routing, if the a path property is provided with a routing strategy other than path a runtime error will be thrown.

Example that will throw an error:

<SignIn routing='hash' path='/sign-in' />

Checklist

  • npm test runs as expected.
  • npm run 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:

Packages affected

  • @clerk/backend
  • @clerk/chrome-extension
  • @clerk/clerk-js
  • @clerk/clerk-expo
  • @clerk/fastify
  • gatsby-plugin-clerk
  • @clerk/localizations
  • @clerk/nextjs
  • @clerk/clerk-react
  • @clerk/remix
  • @clerk/clerk-sdk-node
  • @clerk/shared
  • @clerk/themes
  • @clerk/types
  • build/tooling/chore

Copy link

changeset-bot bot commented Nov 24, 2023

🦋 Changeset detected

Latest commit: 9d95ebf

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

This PR includes changesets to release 3 packages
Name Type
@clerk/clerk-js Major
@clerk/chrome-extension Patch
@clerk/clerk-expo 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

@octoper octoper force-pushed the vaggelis/sdk-56-throw-an-error-if-routing-component-params-are-used branch from 346b84c to 1c2d09c Compare November 24, 2023 11:19
@dimkl dimkl self-requested a review November 24, 2023 11:21
@octoper octoper force-pushed the vaggelis/sdk-56-throw-an-error-if-routing-component-params-are-used branch from 98d7d45 to 9d95ebf Compare November 24, 2023 11:41
@octoper octoper added this pull request to the merge queue Nov 24, 2023
Merged via the queue into main with commit 043801f Nov 24, 2023
7 checks passed
@octoper octoper deleted the vaggelis/sdk-56-throw-an-error-if-routing-component-params-are-used branch November 24, 2023 11:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants