Skip to content

fix(matcher): add workaround hint to invalid params warning #2662

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
shanliuling wants to merge 2 commits into
base: main
Choose a base branch
from
+11 −2
Open

fix(matcher): add workaround hint to invalid params warning #2662

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e5667ca
fix(matcher): add workaround hint to invalid params warning (#1617)
klz Mar 16, 2026
d4ac731
fix(matcher): only show workaround hint when target route has no params
shanliuling Mar 19, 2026
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
4 changes: 3 additions & 1 deletion packages/router/__tests__/warnings.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,7 +313,9 @@ describe('warnings', () => {
meta: {},
}
)
expect('invalid param(s) "no", "foo" ').toHaveBeenWarned()
expect('invalid param(s) "no", "foo"').toHaveBeenWarned()
// workaround hint should be shown
expect('If you are using a catch-all route').toHaveBeenWarned()
// from the previous location
expect('"one"').not.toHaveBeenWarned()
})
Expand Down
9 changes: 8 additions & 1 deletion packages/router/src/matcher/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,10 +263,17 @@ export function createRouterMatcher(
).filter(paramName => !matcher!.keys.find(k => k.name === paramName))

if (invalidParams.length) {
const hasParamsToSuggest =
!matcher!.keys.length && Object.keys(currentLocation.params).length

warn(
`Discarded invalid param(s) "${invalidParams.join(
'", "'
)}" when navigating. See https://github.com/vuejs/router/blob/main/packages/router/CHANGELOG.md#414-2022-08-22 for more details.`
)}" when navigating.` +
(hasParamsToSuggest
? ` If you are using a catch-all route with a named redirect, pass an empty \`params\` object: \`redirect: { name: '...', params: {} }\`.`
: '') +
` See https://github.com/vuejs/router/blob/main/packages/router/CHANGELOG.md#414-2022-08-22 for more details.`
)
}
}
Expand Down