Add support for relative routes

Update based on feedback

Author: LukasMirbt

packages/go_router_builder/README.md

@@ -455,7 +455,8 @@ An example is available [here](https://github.com/flutter/packages/blob/main/pac
 
 ## Relative routes
 
-Define a relative route by extending RelativeGoRouteData.
+Relative routes allow reusing the same `RouteData` in different parts of the route tree.
+Define a relative route by extending `RelativeGoRouteData`.
 
 <?code-excerpt "example/lib/readme_excerpts.dart (relativeRoute)"?>
 ```dart

packages/go_router_builder/example/lib/go_relative.g.dart

@@ -190,8 +190,9 @@ class StatefulShellBranchConfig extends RouteBaseConfig {
 mixin _GoRouteMixin on RouteBaseConfig {
   String get _basePathForLocation;
 
-  late final Set<String> _pathParams =
-      pathParametersFromPattern(_basePathForLocation);
+  late final Set<String> _pathParams = pathParametersFromPattern(
+    _basePathForLocation,
+  );
 
   // construct path bits using parent bits
   // if there are any queryParam objects, add in the `queryParam` bits
@@ -377,7 +378,7 @@ mixin _GoRouteMixin on RouteBaseConfig {
   Iterable<String> _enumDeclarations() {
     final Set<InterfaceType> enumParamTypes = <InterfaceType>{};
 
-    for (final ParameterElement ctorParam in <ParameterElement>[
+    for (final FormalParameterElement ctorParam in <FormalParameterElement>[
       ..._ctorParams,
       ..._ctorQueryParams,
     ]) {
@@ -461,7 +462,7 @@ class GoRouteConfig extends RouteBaseConfig with _GoRouteMixin {
     }
 
     return '''
-mixin $_mixinName on GoRouteData {
+mixin $_mixinName on $routeDataClassName {
   static $_className _fromState(GoRouterState state) $_fromStateConstructor
   $_castedSelf
   @override
@@ -522,7 +523,8 @@ class RelativeGoRouteConfig extends RouteBaseConfig with _GoRouteMixin {
 
   @override
   String get _mixinDefinition {
-    final bool hasMixin = getNodeDeclaration<ClassDeclaration>(routeDataClass)
+    final bool hasMixin =
+        getNodeDeclaration<ClassDeclaration>(routeDataClass)
             ?.withClause
             ?.mixinTypes
             .any((NamedType e) => e.name2.toString() == _mixinName) ??
@@ -536,14 +538,14 @@ class RelativeGoRouteConfig extends RouteBaseConfig with _GoRouteMixin {
     }
 
     return '''
-mixin $_mixinName on RelativeGoRouteData {
+mixin $_mixinName on $routeDataClassName {
   static $_className _fromState(GoRouterState state) $_fromStateConstructor
   $_castedSelf
   @override
-  String get location => RelativeGoRouteData.\$location($_locationArgs,$_locationQueryParams);
+  String get subpath => RelativeGoRouteData.\$location($_locationArgs,$_locationQueryParams);
   
   @override
-  String get relativeLocation => './\$location';
+  String get relativeLocation => './\$subpath';
 
   @override
   void goRelative(BuildContext context) =>
@@ -749,12 +751,19 @@ abstract class RouteBaseConfig {
         throw UnsupportedError('Unrecognized type $typeName');
     }
 
-    value._children.addAll(reader
-        .read(_generateChildrenGetterName(typeName))
-        .listValue
-        .map<RouteBaseConfig>((DartObject e) => RouteBaseConfig._fromAnnotation(
-            ConstantReader(e), element, value,
-            isAncestorRelative: isRelative),),);
+    value._children.addAll(
+      reader
+          .read(_generateChildrenGetterName(typeName))
+          .listValue
+          .map<RouteBaseConfig>(
+            (DartObject e) => RouteBaseConfig._fromAnnotation(
+              ConstantReader(e),
+              element,
+              value,
+              isAncestorRelative: isRelative,
+            ),
+          ),
+    );
 
     return value;
   }

packages/go_router_builder/example/lib/readme_excerpts.g.dart

@@ -11,11 +11,11 @@ mixin _$InnerRelativeRoute {}
 
 const TypedRelativeGoRoute<RelativeRoute> relativeRoute =
     TypedRelativeGoRoute<RelativeRoute>(
-  path: 'relative-route',
-  routes: <TypedRoute<RouteData>>[
-    TypedRelativeGoRoute<InnerRelativeRoute>(path: 'inner-relative-route')
-  ],
-);
+      path: 'relative-route',
+      routes: <TypedRoute<RouteData>>[
+        TypedRelativeGoRoute<InnerRelativeRoute>(path: 'inner-relative-route'),
+      ],
+    );
 
 @TypedGoRoute<Route1>(
   path: 'route-1',

packages/go_router_builder/lib/src/route_config.dart

@@ -41,12 +41,12 @@ mixin _$RelativeRoute on RelativeGoRouteData {
   static RelativeRoute _fromState(GoRouterState state) => const RelativeRoute();
 
   @override
-  String get location => RelativeGoRouteData.$location(
+  String get subpath => RelativeGoRouteData.$location(
         'relative-route',
       );
 
   @override
-  String get relativeLocation => './$location';
+  String get relativeLocation => './$subpath';
 
   @override
   void goRelative(BuildContext context) => context.go(relativeLocation);
@@ -69,12 +69,12 @@ mixin _$InnerRelativeRoute on RelativeGoRouteData {
       const InnerRelativeRoute();
 
   @override
-  String get location => RelativeGoRouteData.$location(
+  String get subpath => RelativeGoRouteData.$location(
         'inner-relative-route',
       );
 
   @override
-  String get relativeLocation => './$location';
+  String get relativeLocation => './$subpath';
 
   @override
   void goRelative(BuildContext context) => context.go(relativeLocation);

packages/go_router_builder/test_inputs/go_relative.dart

@@ -6,9 +6,7 @@ import 'package:go_router/go_router.dart';
 
 mixin _$RelativeRoute {}
 
-@TypedRelativeGoRoute<RelativeRoute>(
-  path: '/relative-route',
-)
+@TypedRelativeGoRoute<RelativeRoute>(path: '/relative-route')
 class RelativeRoute extends RelativeGoRouteData with _$RelativeRoute {
   const RelativeRoute();
 }

packages/go_router_builder/test_inputs/go_relative.dart.expect

@@ -18,11 +18,11 @@ class HomeRoute extends GoRouteData with _$HomeRoute {
 
 const TypedRelativeGoRoute<RelativeRoute> relativeRoute =
     TypedRelativeGoRoute<RelativeRoute>(
-  path: 'relative-route',
-  routes: <TypedRoute<RouteData>>[
-    TypedGoRoute<NonRelativeRoute>(path: 'non-relative-route'),
-  ],
-);
+      path: 'relative-route',
+      routes: <TypedRoute<RouteData>>[
+        TypedGoRoute<NonRelativeRoute>(path: 'non-relative-route'),
+      ],
+    );
 
 class RelativeRoute extends RelativeGoRouteData with _$RelativeRoute {
   const RelativeRoute();

packages/go_router_builder/test_inputs/relative_route_with_absolute_path.dart

@@ -19,15 +19,17 @@ class HomeRoute extends GoRouteData with _$HomeRoute {
 
 const TypedRelativeGoRoute<RelativeRoute> relativeRoute =
     TypedRelativeGoRoute<RelativeRoute>(
-  path: 'relative-route',
-  routes: <TypedRoute<RouteData>>[shellRoute],
-);
+      path: 'relative-route',
+      routes: <TypedRoute<RouteData>>[shellRoute],
+    );
 
-const TypedShellRoute<ShellRoute> shellRoute =
-    TypedShellRoute<ShellRoute>(routes: <TypedRoute<RouteData>>[absoluteRoute]);
+const TypedShellRoute<ShellRoute> shellRoute = TypedShellRoute<ShellRoute>(
+  routes: <TypedRoute<RouteData>>[absoluteRoute],
+);
 
-const TypedGoRoute<AbsoluteRoute> absoluteRoute =
-    TypedGoRoute<AbsoluteRoute>(path: 'absolute-route');
+const TypedGoRoute<AbsoluteRoute> absoluteRoute = TypedGoRoute<AbsoluteRoute>(
+  path: 'absolute-route',
+);
 
 class RelativeRoute extends RelativeGoRouteData with _$RelativeRoute {
   const RelativeRoute();