feat: allow defining an empty name to remove a route from the map

Author: posva

playground/src/pages/(some-layout).vue

@@ -1,3 +1,9 @@
+<script setup lang="ts">
+definePage({
+  name: '',
+})
+</script>
+
 <template>
   <div>
     This is a layout page

playground/typed-router.d.ts

@@ -18,7 +18,6 @@ declare module 'vue-router/auto-routes' {
    * Route name map generated by unplugin-vue-router
    */
   export interface RouteNamedMap {
-    '/(some-layout)': RouteRecordInfo<'/(some-layout)', '/', Record<never, never>, Record<never, never>, '/(some-layout)/app' | '/(some-layout)/home'>,
     '/(some-layout)/app': RouteRecordInfo<'/(some-layout)/app', '/app', Record<never, never>, Record<never, never>>,
     '/(some-layout)/home': RouteRecordInfo<'/(some-layout)/home', '/home', Record<never, never>, Record<never, never>>,
     '/(test-group)': RouteRecordInfo<'/(test-group)', '/', Record<never, never>, Record<never, never>, '/(test-group)/test-group-child'>,

src/codegen/generateRouteMap.ts

@@ -10,7 +10,7 @@ ${node.getSortedChildren().map(generateRouteNamedMap).join('')}}`
   return (
     // if the node has a filePath, it's a component, it has a routeName and it should be referenced in the RouteNamedMap
     // otherwise it should be skipped to avoid navigating to a route that doesn't render anything
-    (node.value.components.size > 0
+    (node.value.components.size > 0 && node.name
       ? `  '${node.name}': ${generateRouteRecordInfo(node)},\n`
       : '') +
     (node.children.size > 0

src/core/tree.ts

@@ -228,11 +228,20 @@ export class TreeNode {
     return this.value.fullPath
   }
 
+  get components() {
+    return Object.fromEntries(this.value.components.entries())
+  }
+
   /**
    * Returns the route name of the node. If the name was overridden, it returns the override.
    */
   get name() {
-    return this.value.overrides.name || this.options.getRouteName(this)
+    const overrideName = this.value.overrides.name
+    // allows passing a null or empty name so the route is not named
+    // and isn't listed in the route map
+    return overrideName !== undefined
+      ? overrideName
+      : this.options.getRouteName(this)
   }
 
   /**