feat(warn): improve infinite redirect warning message

posva · posva · commit 2abecb71500e · 2023-04-25T15:26:27.000+02:00
diff --git a/packages/router/src/router.ts b/packages/router/src/router.ts
@@ -719,7 +719,7 @@ export function createRouter(options: RouterOptions): Router {
                 : 1) > 30
             ) {
               warn(
-                `Detected a possibly infinite redirection in a navigation guard when going from "${from.fullPath}" to "${toLocation.fullPath}". Aborting to avoid a Stack Overflow. This might break in production if not fixed.`
+                `Detected a possibly infinite redirection in a navigation guard when going from "${from.fullPath}" to "${toLocation.fullPath}". Aborting to avoid a Stack Overflow.\n Are you always returning a new location within a navigation guard? That would lead to this error. Only return when redirecting or aborting, that should fix this. This might break in production if not fixed.`
               )
               return Promise.reject(
                 new Error('Infinite redirect in navigation guard')

Original file line number	Diff line number	Diff line change
`@@ -719,7 +719,7 @@ export function createRouter(options: RouterOptions): Router {`
`719`	`719`	`: 1) > 30`
`720`	`720`	`) {`
`721`	`721`	`warn(`
`722`		- `Detected a possibly infinite redirection in a navigation guard when going from "${from.fullPath}" to "${toLocation.fullPath}". Aborting to avoid a Stack Overflow. This might break in production if not fixed.`
	`722`	+ `Detected a possibly infinite redirection in a navigation guard when going from "${from.fullPath}" to "${toLocation.fullPath}". Aborting to avoid a Stack Overflow.\n Are you always returning a new location within a navigation guard? That would lead to this error. Only return when redirecting or aborting, that should fix this. This might break in production if not fixed.`
`723`	`723`	`)`
`724`	`724`	`return Promise.reject(`
`725`	`725`	`new Error('Infinite redirect in navigation guard')`