Zengtudor/Nuxt
1
0
Fork 0
mirror of https://github.com/nuxt/nuxt.git synced 2025-01-19 01:45:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix(nuxt): prevent hyphens forming child routes & warn if dupes are detected (#18944)

Browse Source
This commit is contained in:
Daniel Roe 2023-02-13 22:56:39 +00:00 committed by GitHub
parent 859fbd0add
commit 4219ff21e9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 46 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
packages/nuxt/src/pages/utils.ts
View File

@ -72,7 +72,7 @@ export function generateRoutesFromFiles (files: string[], pagesDir: string): Nux
const segmentName = tokens.map(({ value }) => value).join('')
// ex: parent/[slug].vue -> parent-slug
route.name += (route.name && '-') + segmentName
route.name += (route.name && '/') + segmentName
// ex: parent.vue + parent/child.vue
const child = parent.find(parentRoute => parentRoute.name === route.name && !parentRoute.path.endsWith('(.*)*'))
@ -200,11 +200,28 @@ function parseSegment (segment: string) {
return tokens
}
function prepareRoutes (routes: NuxtPage[], parent?: NuxtPage) {
function findRouteByName (name: string, routes: NuxtPage[]): NuxtPage | undefined {
for (const route of routes) {
if (route.name === name) {
return route
}
}
return findRouteByName(name, routes)
}
function prepareRoutes (routes: NuxtPage[], parent?: NuxtPage, names = new Set<string>()) {
for (const route of routes) {
// Remove -index
if (route.name) {
route.name = route.name.replace(/-index$/, '')
route.name = route.name
.replace(/\/index$/, '')
.replace(/\//g, '-')
if (names.has(route.name)) {
const existingRoute = findRouteByName(route.name, routes)
const extra = existingRoute?.name ? `is the same as \`${existingRoute.file}\`` : 'is a duplicate'
console.warn(`[nuxt] Route name generated for \`${route.file}\` ${extra}. You may wish to set a custom name using \`definePageMeta\` within the page file.`)
}
}
// Remove leading / if children route
@ -213,12 +230,16 @@ function prepareRoutes (routes: NuxtPage[], parent?: NuxtPage) {
}
if (route.children?.length) {
route.children = prepareRoutes(route.children, route)
route.children = prepareRoutes(route.children, route, names)
}
if (route.children?.find(childRoute => childRoute.path === '')) {
delete route.name
}
if (route.name) {
names.add(route.name)
}
}
return routes

21
packages/nuxt/test/pages.test.ts
View File

@ -55,6 +55,27 @@ describe('pages:generateRoutesFromFiles', () => {
}
]
},
{
description: 'should not generate colliding route names when hyphens are in file name',
files: [
`${pagesDir}/parent/[child].vue`,
`${pagesDir}/parent-[child].vue`
],
output: [
{
name: 'parent-child',
path: '/parent/:child',
file: `${pagesDir}/parent/[child].vue`,
children: []
},
{
name: 'parent-child',
path: '/parent-:child',
file: `${pagesDir}/parent-[child].vue`,
children: []
}
]
},
{
description: 'should generate correct id for catchall (order 1)',
files: [