Type-safe href by pcattori · Pull Request #12994 · remix-run/react-router

pcattori · 2025-02-10T20:57:32Z

import { href } from "react-router"

href("/a")
href("/b/:b", { b: "wow" })
href("/c/:c?") // all params are optional, so you can omit the 2nd arg entirely if you want
href("/c/:c?", { c: "wow" })

You should get:

Autocomplete for all possible paths (1st arg)
Type checking error if params (2nd arg) are provided for paths without args (e.g. /a)
Type checking error if wrong params are provided for a path (e.g. ("/b/:b", { notb: "wrong" }))
Autocomplete for params after path has been provided
Ability to omit params when all params in path are optional

Experimental releases

~~0.0.0-experimental-208f173a8~~
~~0.0.0-experimental-263c97949~~
0.0.0-experimental-8e9d8ef63

TODO

changesets (feat:href + fix:params)
tests
normalize full URL path

changeset-bot · 2025-02-10T20:57:36Z

🦋 Changeset detected

Latest commit: 0487323

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

This PR includes changesets to release 11 packages

Name	Type
@react-router/dev	Patch
react-router	Patch
@react-router/fs-routes	Patch
@react-router/remix-routes-option-adapter	Patch
@react-router/architect	Patch
@react-router/cloudflare	Patch
react-router-dom	Patch
@react-router/express	Patch
@react-router/node	Patch
@react-router/serve	Patch
create-react-router	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

packages/react-router-dev/typegen/index.ts

packages/react-router/lib/types/register.ts

pcattori · 2025-02-12T05:06:51Z

Looks like Node v22.14 was just released so CI is using that, but it broke some of our unit tests. Seems unrelated to any changes in this PR.

UPDATE: should be fixed with the latest commit in this PR

hilja · 2025-02-12T13:12:30Z

packages/react-router/lib/href.ts

+  return path
+    .split("/")
+    .map((segment) => {
+      const match = segment.match(/^:([\w-]+)(\?)?/);


Nit, but this regex could be cached outside the loop.

The `--version` flag reads the local `package.json` at `../package.json`. While this path is correct when running from source, it is incorrect after the CLI is built since `package.json` stays at the root of the package, but the built code gets nested into `dist/`. I only noticed this discrepancy because I was converting the unit tests to integration tests to fix an incompatibility issue with Node v22.14 and `esbuild-register`.

* wip: type-safe href * consistent params parsing + type generation * href tests * href typegen tests * href types normalize route full path * fix `react-router --version` The `--version` flag reads the local `package.json` at `../package.json`. While this path is correct when running from source, it is incorrect after the CLI is built since `package.json` stays at the root of the package, but the built code gets nested into `dist/`. I only noticed this discrepancy because I was converting the unit tests to integration tests to fix an incompatibility issue with Node v22.14 and `esbuild-register`.

* Type-safe href (#12994) * wip: type-safe href * consistent params parsing + type generation * href tests * href typegen tests * href types normalize route full path * fix `react-router --version` The `--version` flag reads the local `package.json` at `../package.json`. While this path is correct when running from source, it is incorrect after the CLI is built since `package.json` stays at the root of the package, but the built code gets nested into `dist/`. I only noticed this discrepancy because I was converting the unit tests to integration tests to fix an incompatibility issue with Node v22.14 and `esbuild-register`. * bump patch to minor for new API: `href`

…d-route-typegen * upstream/dev: bump patch to minor for new API: `href` Type-safe href (remix-run#12994) docs: prerender/ssr:false (remix-run#13005) Skip action-only resource routes with prerender:true (remix-run#13004) Update docs for spa/prerendering Improvements to ssr:false + prerender scenarios (remix-run#12948)

github-actions · 2025-02-13T22:03:30Z

🤖 Hello there,

We just published version 7.2.0-pre.2 which includes this pull request. If you'd like to take it for a test run please try it out and let us know what you think!

Thanks!

github-actions · 2025-02-18T17:15:19Z

🤖 Hello there,

We just published version 7.2.0-pre.5 which includes this pull request. If you'd like to take it for a test run please try it out and let us know what you think!

Thanks!

ngbrown · 2025-02-20T16:47:43Z

@pcattori and @brophdawg11: Wasn't href released in v7.2.0 through #13012? This changeset is still showing as a minor version bump in the dev branch:

https://github.com/remix-run/react-router/blob/dev/.changeset/three-eyes-flow.md

brophdawg11 · 2025-02-27T17:09:34Z

Yeah I noticed that this AM too - I think it's because a few of these changes in 7.2.0 landed in dev and then got cherry-picked to release-next so merging release-next down to dev after the 7.2.0 release didn't delete them like it normally would. I'll remove them manually now - thanks for the heads up!

github-actions · 2025-03-06T21:04:00Z

🤖 Hello there,

We just published version 7.3.0 which includes this pull request. If you'd like to take it for a test run please try it out and let us know what you think!

Thanks!

remix-cla-bot bot added the CLA Signed label Feb 10, 2025

pcattori changed the base branch from main to dev February 10, 2025 20:57

pcattori force-pushed the pedro/type-safe-href branch from 8ed1541 to 004e483 Compare February 10, 2025 20:58

pcattori commented Feb 10, 2025

View reviewed changes

packages/react-router-dev/typegen/index.ts Outdated Show resolved Hide resolved

pcattori commented Feb 10, 2025

View reviewed changes

packages/react-router/lib/types/register.ts Outdated Show resolved Hide resolved

pcattori force-pushed the pedro/type-safe-href branch from 208f173 to 9849f77 Compare February 11, 2025 03:26

pcattori added 2 commits February 11, 2025 15:58

wip: type-safe href

425ed5c

consistent params parsing + type generation

fe2ff5d

pcattori force-pushed the pedro/type-safe-href branch from b268db6 to fe2ff5d Compare February 11, 2025 20:58

href tests

67b2728

pcattori marked this pull request as ready for review February 11, 2025 21:40

href typegen tests

263c979

pcattori force-pushed the pedro/type-safe-href branch from c69ff0e to 263c979 Compare February 11, 2025 21:58

href types normalize route full path

8e9d8ef

hilja reviewed Feb 12, 2025

View reviewed changes

pcattori merged commit 4d88d8a into dev Feb 12, 2025
8 checks passed

pcattori deleted the pedro/type-safe-href branch February 12, 2025 18:20

pcattori mentioned this pull request Feb 12, 2025

Type-safe href #12697

Closed

pcattori linked an issue Feb 12, 2025 that may be closed by this pull request

Type-safe href #12697

Closed

pcattori mentioned this pull request Feb 12, 2025

draft: typesafety #12752

Closed

11 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Type-safe href#12994

Type-safe href#12994
pcattori merged 6 commits intodevfrom
pedro/type-safe-href

pcattori commented Feb 10, 2025 •

edited

Loading

Uh oh!

changeset-bot bot commented Feb 10, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

pcattori commented Feb 12, 2025 •

edited

Loading

Uh oh!

hilja Feb 12, 2025

Uh oh!

Uh oh!

github-actions bot commented Feb 13, 2025

Uh oh!

github-actions bot commented Feb 18, 2025

Uh oh!

ngbrown commented Feb 20, 2025

Uh oh!

brophdawg11 commented Feb 27, 2025

Uh oh!

github-actions bot commented Mar 6, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

pcattori commented Feb 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Experimental releases

TODO

Uh oh!

changeset-bot bot commented Feb 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

Uh oh!

Uh oh!

pcattori commented Feb 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hilja Feb 12, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot commented Feb 13, 2025

Uh oh!

github-actions bot commented Feb 18, 2025

Uh oh!

ngbrown commented Feb 20, 2025

Uh oh!

brophdawg11 commented Feb 27, 2025

Uh oh!

github-actions bot commented Mar 6, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

pcattori commented Feb 10, 2025 •

edited

Loading

changeset-bot bot commented Feb 10, 2025 •

edited

Loading

pcattori commented Feb 12, 2025 •

edited

Loading