Parse regex to calculate accurate types for generatePath

[devonpmack]

When calling generatePath('/pages/:page(comments|latest_activity)') by parsing the regex, we should be able to automatically enforce that the page parameter is one of comments | latest_activity.

This PR implements that parsing:

  ExtractRouteParams<'/posts/:postId'> // { postId: string | null }>
  ExtractRouteParams<'/pages/:page(comments|latest_activity)'> // { page: 'comments' | 'latest_activity' | null }>
  ExtractRouteParams<'/page/:page(home|comments\d+)'> // { page: string | null }>,

If the path contains regex symbols like :page(\d+|activity) then it will not try to parse the types.

This could be a breaking change if anyone is incorrectly calling generatePath with arguments that aren't part of the (|) in the regexp.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 3b6f558

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

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

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[remix-cla-bot]

Hi @devonpmack,

Welcome, and thank you for contributing to React Router!

Before we consider your pull request, we ask that you sign our Contributor License Agreement (CLA). We require this only once.

You may review the CLA and sign it by adding your name to contributors.yml.

Once the CLA is signed, the CLA Signed label will be added to the pull request.

If you have already signed the CLA and received this response in error, or if you have any questions, please contact us at [email protected].

Thanks!

- The Remix team

[remix-cla-bot]

Thank you for signing the Contributor License Agreement. Let's get this merged! 🥳