Skip to content

refactor(router-core): add error when building route tree if trying to add children routes to an index route #5897

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
Sheraff wants to merge 6 commits into
base: main
Choose a base branch
from
+19 −0
Open

refactor(router-core): add error when building route tree if trying to add children routes to an index route #5897

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9715c1f
refactor(router-core): add error when building route tree if trying t…
Sheraff Nov 18, 2025
72feec7
ci: apply automated fixes
autofix-ci[bot] Nov 18, 2025
d58282e
more invariant checks
Sheraff Nov 18, 2025
a7adfcb
better use of invariant
Sheraff Nov 18, 2025
2576b28
run checks after init to access id / fullPath
Sheraff Nov 18, 2025
60e5fea
fix invariant condition
Sheraff Nov 18, 2025
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
19 changes: 19 additions & 0 deletions packages/router-core/src/route.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1707,6 +1707,25 @@ export class BaseRoute<
this._id = id as TId
this._fullPath = fullPath as TFullPath
this._to = fullPath as TrimPathRight<TFullPath>

if (process.env.NODE_ENV !== 'production') {
if (this.parentRoute) {
invariant(
this.parentRoute.isRoot || !this.parentRoute.fullPath.endsWith('/'),
`Parent route with id '${this.parentRoute.id}' returned by getParentRoute on '${this.id}' is an index route and cannot have child routes.`,
)
invariant(
this.parentRoute.children && this.parentRoute.children.includes(this),
`Parent route with id '${this.parentRoute.id}' returned by getParentRoute has no child route with id '${this.id}'. Did you forget to call .addChildren()?`,
)
}
if (this.children) {
invariant(
this.isRoot || !this.fullPath.endsWith('/'),
Copy link
Contributor

@schiller-manuel schiller-manuel Nov 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is the negation incorrect here?

Copy link
Contributor Author

@Sheraff Sheraff Nov 29, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmmm in invariant the 1st param must be true to not throw, right? If this is correct, then I think the condition is good:

  • If there are children
    • the route must either be the root
    • or not be an index (i.e. not endsWith('/'))

Just checked the docs https://www.npmjs.com/package/tiny-invariant:

invariant(truthyValue, 'This should not throw!');

invariant(falsyValue, 'This will throw!');
// Error('Invariant violation: This will throw!');

This seems correct to me then

`Cannot add children to index route '${this.id}'. Index routes cannot have child routes.`,
)
}
}
}

addChildren: RouteAddChildrenFn<
Expand Down
Loading