`_` folder breaks getRouteApi matching

[AshotN]

Which project does this relate to?

Router

Describe the bug

getRouteApi is unable to math paths when called from a _ folder that.

Your Example Website or App

https://github.com/AshotN/TanStack-Router-routeAPIBug

Steps to Reproduce the Bug or Issue

1. Clone provided repo
2. Navigate to http://localhost:3000/dir/123. Notice it works
3. Navigate to http://localhost:3000/dir/123/file. Fails

Expected behavior

I would expect both paths to be able to read the param {id: 123}

Screenshots or Videos

No response

Platform

• Router / Start Version: 1.132.23

Additional context

No response

[nlynzaad]

Thanks for reporting and the reproducer. Will investigate and get back to you.

[anymaniax]

I think I got the same error with a route with a param that end with _ and got strip away when passing it to a link. So for example I have a path /example/id_ and when passing it to a Link component in the browser I see /example/id. To fix it I check if the path end with _ and in that case I need to add __ at the end and if I do that the path is correct in the browser

[nlynzaad]

@AshotN thanks again for filing the issue, following your issue and others, we are busy looking into non-nested routes in a more holistic manner.

That being said, your specific issue seems to be rooted elsewhere:

let's say you have the following route structure:

- foo
- - $bar
- - - route.tsx
- - - baz.tsx
- - $bar_ 
- - - qux.tsx

Since /foo/$bar has a route file it is regarded as a full-fledged route with its own routeId. /foo/bar_ is not a route but part of the route /foo/$bar_/qux

When using non-nested paths, we are essentially creating a fork in the routeTree, this is to ensure that qux's direct parent is foo and not bar:

                    ______ `$bar` ____ `baz`
                  /
-----`foo`--
                  \______ `$bar_` ___ `qux`

we should now also consider that getRouteApi takes a routeId and uses that to resolve the route with its params etc.

So, with this in mind:

• when accessing getRouteApi('/foo/$bar') while being on /foo/$bar/baz this will resolve since /foo/$bar is an actual route in the current routeTree.

• when accessing getRouteApi('/foo/$bar') while being on /foo/$bar_/qux this will not resolve since /foo/$bar is not an actual route in the current routeTree, it's a route on the other forked branch.

to address your problem, it's probably better to make use of pathless layout routes, replicating the structure of the repo:

- foo
- - $bar
- - - _layout1
- - - - - route.tsx
- - - - - baz.tsx
- - - qux.tsx
- - - route.tsx

[nlynzaad]

I think I got the same error with a route with a param that end with _ and got strip away when passing it to a link. So, for example I have a path /example/id_ and when passing it to a Link component in the browser I see /example/id. To fix it I check if the path end with _ and in that case I need to add __ at the end and if I do that the path is correct in the browser

@anymaniax in file-based routing the trailing underscore indicates that a route should be a non-nested route. From your description I'm assuming you are either using file-based routing but don't want the non-nested functionality and want the trailing underscore to remain or you are using code-based routing and the _ is being stripped when it shouldn't be.

We are aware of 2 issues:

1. when using file-based routing you will have to escape the trailing _ this is not currently working, and we are addressing it.
2. when using code-based routing the trailing underscore should not be stripped but inadvertently is. we are also addressing this issue in the same discussions and hopefully a fix will be out soon.

[AshotN]

I will give your suggestion a try.

In the future will the router be able to handle the example in the repo? Or is this something that you guys are considering as expected behavior?