feat: extract alias from definePage

Author: posva

packages/router/src/unplugin/core/definePage.spec.ts

@@ -243,6 +243,74 @@ definePage({
     })
   })
 
+  it('extracts alias as a string', () => {
+    const code = vue`
+<script setup>
+definePage({
+  alias: '/other',
+})
+</script>
+`
+    expect(extractDefinePageInfo(code, 'src/pages/test.vue')).toEqual({
+      alias: ['/other'],
+    })
+  })
+
+  it('extracts alias as an array of strings', () => {
+    const code = vue`
+<script setup>
+definePage({
+  alias: ['/a', '/b'],
+})
+</script>
+`
+    expect(extractDefinePageInfo(code, 'src/pages/test.vue')).toEqual({
+      alias: ['/a', '/b'],
+    })
+  })
+
+  it('warns on invalid alias (number)', () => {
+    const code = vue`
+<script setup>
+definePage({
+  alias: 123,
+})
+</script>
+`
+    expect(extractDefinePageInfo(code, 'src/pages/test.vue')).toEqual({})
+    expect(
+      'route alias must be a string literal or an array of string literals'
+    ).toHaveBeenWarned()
+  })
+
+  it('warns on invalid alias (variable)', () => {
+    const code = vue`
+<script setup>
+const someVar = '/other'
+definePage({
+  alias: someVar,
+})
+</script>
+`
+    expect(extractDefinePageInfo(code, 'src/pages/test.vue')).toEqual({})
+    expect(
+      'route alias must be a string literal or an array of string literals'
+    ).toHaveBeenWarned()
+  })
+
+  it('filters non-string elements from alias array', () => {
+    const code = vue`
+<script setup>
+definePage({
+  alias: ['/a', 123, '/b'],
+})
+</script>
+`
+    expect(extractDefinePageInfo(code, 'src/pages/test.vue')).toEqual({
+      alias: ['/a', '/b'],
+    })
+  })
+
   it('extract name skipped when non existent', async () => {
     expect(
       extractDefinePageInfo(

packages/router/src/unplugin/core/definePage.ts

@@ -213,6 +213,7 @@ type DefinePageParamsInfo = NonNullable<CustomRouteBlock['params']>
 export interface DefinePageInfo {
   name?: string | false
   path?: string
+  alias?: string[]
   params?: CustomRouteBlock['params']
 }
 
@@ -286,6 +287,8 @@ export function extractDefinePageInfo(
         } else {
           routeInfo.path = prop.value.value
         }
+      } else if (prop.key.name === 'alias') {
+        routeInfo.alias = extractRouteAlias(prop.value, id)
       } else if (prop.key.name === 'params') {
         if (prop.value.type === 'ObjectExpression') {
           routeInfo.params = extractParamsInfo(prop.value, id)
@@ -418,23 +421,25 @@ function extractPathParams(
   return pathParams
 }
 
-// TODO: use
 export function extractRouteAlias(
   aliasValue: ObjectProperty['value'],
   id: string
-): string[] | void {
+): string[] | undefined {
   if (
     aliasValue.type !== 'StringLiteral' &&
     aliasValue.type !== 'ArrayExpression'
   ) {
-    warn(`route alias must be a string literal. Found in "${id}".`)
+    warn(
+      `route alias must be a string literal or an array of string literals. Found in "${id}".`
+    )
   } else {
     return aliasValue.type === 'StringLiteral'
       ? [aliasValue.value]
       : aliasValue.elements
           .filter(node => node?.type === 'StringLiteral')
           .map(el => el.value)
   }
+  return undefined
 }
 
 const getIdentifiers = (stmts: Statement[]) => {