Skip to content

Commit d9f3174

Browse files
posvaposva
committed
feat: add aliasOf to normalized records
1 parent 234f531 commit d9f3174

File tree

6 files changed

+67
-5
lines changed

6 files changed

+67
-5
lines changed

‎__tests__/matcher/resolve.spec.ts

+46-3
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,10 @@ describe('Router Matcher', () => {
4848
resolved.matched = record.map(normalizeRouteRecord)
4949
// allow passing an expect.any(Array)
5050
else if (Array.isArray(resolved.matched))
51-
resolved.matched = resolved.matched.map(normalizeRouteRecord as any)
51+
resolved.matched = resolved.matched.map(m => ({
52+
...normalizeRouteRecord(m as any),
53+
aliasOf: m.aliasOf,
54+
}))
5255
}
5356

5457
// allows not passing params
@@ -60,7 +63,10 @@ describe('Router Matcher', () => {
6063

6164
const startCopy = {
6265
...start,
63-
matched: start.matched.map(normalizeRouteRecord),
66+
matched: start.matched.map(m => ({
67+
...normalizeRouteRecord(m),
68+
aliasOf: m.aliasOf,
69+
})),
6470
}
6571

6672
// make matched non enumerable
@@ -111,6 +117,38 @@ describe('Router Matcher', () => {
111117
path: '/home',
112118
name: 'Home',
113119
components,
120+
aliasOf: expect.objectContaining({ name: 'Home', path: '/' }),
121+
meta: { foo: true },
122+
},
123+
],
124+
}
125+
)
126+
})
127+
128+
it.todo('multiple aliases')
129+
it.todo('resolve named child with parent with alias')
130+
131+
it('resolves the original record by name', () => {
132+
assertRecordMatch(
133+
{
134+
path: '/',
135+
alias: '/home',
136+
name: 'Home',
137+
components,
138+
meta: { foo: true },
139+
},
140+
{ name: 'Home' },
141+
{
142+
name: 'Home',
143+
path: '/',
144+
params: {},
145+
meta: { foo: true },
146+
matched: [
147+
{
148+
path: '/',
149+
name: 'Home',
150+
components,
151+
aliasOf: undefined,
114152
meta: { foo: true },
115153
},
116154
],
@@ -133,7 +171,12 @@ describe('Router Matcher', () => {
133171
name: 'nested',
134172
params: {},
135173
matched: [
136-
{ path: '/p', children, components },
174+
{
175+
path: '/p',
176+
children,
177+
components,
178+
aliasOf: expect.objectContaining({ path: '/parent' }),
179+
},
137180
{ path: '/p/one', name: 'nested', components },
138181
],
139182
}

‎__tests__/utils.ts

+1
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ export interface RouteRecordViewLoose
2222
'path' | 'name' | 'components' | 'children' | 'meta' | 'beforeEnter'
2323
> {
2424
leaveGuards?: any
25+
aliasOf: RouteRecordViewLoose | undefined
2526
}
2627

2728
// @ts-ignore we are intentionally overriding the type

‎playground/App.vue

+11
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,17 @@
7777
>/nested/nested/nested</router-link
7878
>
7979
</li>
80+
<li>
81+
<router-link to="/anidado">/anidado</router-link>
82+
</li>
83+
<li>
84+
<router-link to="/anidado/nested">/anidado/nested</router-link>
85+
</li>
86+
<li>
87+
<router-link to="/anidado/nested/nested"
88+
>/anidado/nested/nested</router-link
89+
>
90+
</li>
8091
<li>
8192
<router-link to="/long-0">/long-0</router-link>
8293
</li>

‎playground/router.ts

+1
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ export const router = createRouter({
4949
{ path: '/:data(.*)', component: NotFound, name: 'NotFound' },
5050
{
5151
path: '/nested',
52+
alias: '/anidado',
5253
component: Nested,
5354
name: 'Nested',
5455
children: [

‎src/matcher/index.ts

+7-2
Original file line numberDiff line numberDiff line change
@@ -53,14 +53,14 @@ export function createRouterMatcher(
5353
const options: PathParserOptions = { ...globalOptions, ...record.options }
5454
// generate an array of records to correctly handle aliases
5555
const normalizedRecords: RouteRecordNormalized[] = [mainNormalizedRecord]
56-
// TODO: remember aliases in records to allow active in router-link
5756
if ('alias' in record) {
5857
const aliases =
5958
typeof record.alias === 'string' ? [record.alias] : record.alias!
6059
for (const alias of aliases) {
6160
normalizedRecords.push({
6261
...mainNormalizedRecord,
6362
path: alias,
63+
aliasOf: mainNormalizedRecord,
6464
})
6565
}
6666
}
@@ -131,7 +131,9 @@ export function createRouterMatcher(
131131
// console.log('END i is', { i })
132132
// while (i < matchers.length && matcher.score <= matchers[i].score) i++
133133
matchers.splice(i, 0, matcher)
134-
if (matcher.record.name) matcherMap.set(matcher.record.name, matcher)
134+
// only add the original record to the name map
135+
if (matcher.record.name && !matcher.record.aliasOf)
136+
matcherMap.set(matcher.record.name, matcher)
135137
}
136138

137139
/**
@@ -187,6 +189,8 @@ export function createRouterMatcher(
187189
let parentMatcher: RouteRecordMatcher | void = matcher
188190
while (parentMatcher) {
189191
// reversed order so parents are at the beginning
192+
// const { record } = parentMatcher
193+
// TODO: check resolving child routes by path when parent has an alias
190194
matched.unshift(parentMatcher.record)
191195
parentMatcher = parentMatcher.parent
192196
}
@@ -237,6 +241,7 @@ export function normalizeRouteRecord(
237241
beforeEnter,
238242
meta: record.meta || {},
239243
leaveGuards: [],
244+
aliasOf: undefined,
240245
}
241246
}
242247

‎src/matcher/types.ts

+1
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,5 @@ export interface RouteRecordNormalized {
99
meta: Exclude<RouteRecordMultipleViews['meta'], void>
1010
beforeEnter: RouteRecordMultipleViews['beforeEnter']
1111
leaveGuards: NavigationGuard[]
12+
aliasOf: RouteRecordNormalized | undefined
1213
}

0 commit comments

Comments
 (0)