[go_router_builder] Added replace methods to the generated routes. (f…

…lutter#4057) This PR adds replace methods to the generated routes. *List which issues are fixed by this PR. You must list at least one issue.* fixes flutter/flutter#127315 *If you had to change anything in the [flutter/tests] repo, include a link to the migration guide as per the [breaking change policy].* I modified the tests to also check that the replace methods are generated.
pontus-jeong · Jun 27, 2023 · 1984c73 · 1984c73
1 parent f89ce02
commit 1984c73
Show file tree

Hide file tree

Showing 10 changed files with 93 additions and 1 deletion.
diff --git a/packages/go_router_builder/CHANGELOG.md b/packages/go_router_builder/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 2.2.0
+
+* Adds replace methods to the generated routes.
+
 ## 2.1.1
 
 * Fixes a bug that the required/positional parameters are not added to query parameters correctly.

diff --git a/packages/go_router_builder/example/lib/all_types.g.dart b/packages/go_router_builder/example/lib/all_types.g.dart
diff --git a/packages/go_router_builder/example/lib/extra_example.g.dart b/packages/go_router_builder/example/lib/extra_example.g.dart
diff --git a/packages/go_router_builder/example/lib/main.g.dart b/packages/go_router_builder/example/lib/main.g.dart
diff --git a/packages/go_router_builder/example/lib/shell_route_example.g.dart b/packages/go_router_builder/example/lib/shell_route_example.g.dart
diff --git a/packages/go_router_builder/example/lib/shell_route_with_keys_example.g.dart b/packages/go_router_builder/example/lib/shell_route_with_keys_example.g.dart
diff --git a/packages/go_router_builder/example/lib/simple_example.g.dart b/packages/go_router_builder/example/lib/simple_example.g.dart
diff --git a/packages/go_router_builder/lib/src/route_config.dart b/packages/go_router_builder/lib/src/route_config.dart
@@ -217,6 +217,9 @@ extension $_extensionName on $_className {
 
   void pushReplacement(BuildContext context) =>
       context.pushReplacement(location${_extraParam != null ? ', extra: $extraFieldName' : ''});
+
+  void replace(BuildContext context) =>
+      context.replace(location${_extraParam != null ? ', extra: $extraFieldName' : ''});
 }
 ''';
   }

diff --git a/packages/go_router_builder/pubspec.yaml b/packages/go_router_builder/pubspec.yaml
@@ -2,7 +2,7 @@ name: go_router_builder
 description: >-
   A builder that supports generated strongly-typed route helpers for
   package:go_router
-version: 2.1.1
+version: 2.2.0
 repository: https://github.com/flutter/packages/tree/main/packages/go_router_builder
 issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+go_router_builder%22
 

diff --git a/packages/go_router_builder/test/test_inputs/_go_router_builder_test_input.dart b/packages/go_router_builder/test/test_inputs/_go_router_builder_test_input.dart
@@ -79,6 +79,8 @@ extension $NullableRequiredParamNotInPathExtension
 
   void pushReplacement(BuildContext context) =>
       context.pushReplacement(location);
+
+  void replace(BuildContext context) => context.replace(location);
 }
 
 T? _$convertMapValue<T>(
@@ -122,6 +124,8 @@ extension $NonNullableRequiredParamNotInPathExtension
 
   void pushReplacement(BuildContext context) =>
       context.pushReplacement(location);
+
+  void replace(BuildContext context) => context.replace(location);
 }
 ''')
 @TypedGoRoute<NonNullableRequiredParamNotInPath>(path: 'bob')
@@ -151,6 +155,8 @@ extension $EnumParamExtension on EnumParam {
 
   void pushReplacement(BuildContext context) =>
       context.pushReplacement(location);
+
+  void replace(BuildContext context) => context.replace(location);
 }
 
 const _$EnumTestEnumMap = {
@@ -204,6 +210,8 @@ extension $DefaultValueRouteExtension on DefaultValueRoute {
 
   void pushReplacement(BuildContext context) =>
       context.pushReplacement(location);
+
+  void replace(BuildContext context) => context.replace(location);
 }
 
 T? _$convertMapValue<T>(
@@ -248,6 +256,9 @@ extension $ExtraValueRouteExtension on ExtraValueRoute {
 
   void pushReplacement(BuildContext context) =>
       context.pushReplacement(location, extra: $extra);
+
+  void replace(BuildContext context) =>
+      context.replace(location, extra: $extra);
 }
 
 T? _$convertMapValue<T>(
@@ -289,6 +300,9 @@ extension $RequiredExtraValueRouteExtension on RequiredExtraValueRoute {
 
   void pushReplacement(BuildContext context) =>
       context.pushReplacement(location, extra: $extra);
+
+  void replace(BuildContext context) =>
+      context.replace(location, extra: $extra);
 }
 ''')
 @TypedGoRoute<RequiredExtraValueRoute>(path: '/default-value-route')
@@ -335,6 +349,8 @@ extension $IterableWithEnumRouteExtension on IterableWithEnumRoute {
 
   void pushReplacement(BuildContext context) =>
       context.pushReplacement(location);
+
+  void replace(BuildContext context) => context.replace(location);
 }
 
 const _$EnumOnlyUsedInIterableEnumMap = {
@@ -388,6 +404,8 @@ extension $IterableDefaultValueRouteExtension on IterableDefaultValueRoute {
 
   void pushReplacement(BuildContext context) =>
       context.pushReplacement(location);
+
+  void replace(BuildContext context) => context.replace(location);
 }
 ''')
 @TypedGoRoute<IterableDefaultValueRoute>(path: '/iterable-default-value-route')
@@ -416,6 +434,8 @@ extension $NamedRouteExtension on NamedRoute {
 
   void pushReplacement(BuildContext context) =>
       context.pushReplacement(location);
+
+  void replace(BuildContext context) => context.replace(location);
 }
 ''')
 @TypedGoRoute<NamedRoute>(path: '/named-route', name: 'namedRoute')
@@ -442,6 +462,8 @@ extension $NamedEscapedRouteExtension on NamedEscapedRoute {
 
   void pushReplacement(BuildContext context) =>
       context.pushReplacement(location);
+
+  void replace(BuildContext context) => context.replace(location);
 }
 ''')
 @TypedGoRoute<NamedEscapedRoute>(path: '/named-route', name: r'named$Route')