Skip to content

fix(shared): suggest :path* subtree form in createRouteMatcher path types #9057

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.

Sign up for GitHub

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

Open
jacekradko wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(shared): suggest :path* subtree form in createRouteMatcher path types #9057

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/path-matcher-segment-wildcard.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@clerk/shared': patch
---

`createRouteMatcher()` route suggestions now use the `:path*` subtree form (e.g. `/dashboard/:path*`) instead of `(.*)`. Unlike `/dashboard(.*)`, which also matches sibling routes such as `/dashboardxyz`, `/dashboard/:path*` matches only `/dashboard` and its path-segment subtree. Existing `(.*)` patterns keep working; this only changes the type-level autocomplete suggestion.
4 changes: 3 additions & 1 deletion packages/shared/src/pathMatcher.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
import { pathToRegexp } from './pathToRegexp';
import type { Autocomplete } from './types';

export type WithPathPatternWildcard<T = string> = `${T & string}(.*)`;
// Suggests the `:path*` subtree form (e.g. `/dashboard/:path*`), which matches on
// path-segment boundaries. `/` is special-cased to `/:path*` to avoid a malformed `//:path*`.
export type WithPathPatternWildcard<T = string> = T extends '/' ? '/:path*' : `${T & string}/:path*`;
export type PathPattern = Autocomplete<WithPathPatternWildcard>;
export type PathMatcherParam = Array<RegExp | PathPattern> | RegExp | PathPattern;

Expand Down
Loading