feat: add wildcard support on routes (felangel#676)

* initial commit * adding missing tests * docs * Update bricks/dart_frog_prod_server/hooks/pre_gen.dart * Apply suggestions from code review Co-authored-by: Scarlett Eliza <[email protected]> * fix: docs format --------- Co-authored-by: Scarlett Eliza <[email protected]>
alestiago · Jun 8, 2023 · ac8b0b9 · ac8b0b9
1 parent 675dc5e
commit ac8b0b9
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 4 deletions.
diff --git a/bricks/dart_frog_dev_server/__brick__/server.dart b/bricks/dart_frog_dev_server/__brick__/server.dart
diff --git a/bricks/dart_frog_prod_server/__brick__/build/bin/server.dart b/bricks/dart_frog_prod_server/__brick__/build/bin/server.dart
diff --git a/docs/docs/basics/routes.md b/docs/docs/basics/routes.md
@@ -416,6 +416,23 @@ Response onRequest(RequestContext context, String userId, String postId) {
 }
 ```
 
+## Wildcard Routes ♾
+
+Dart Frog supports wildcard routes. For example, if you create a file called `routes/posts/[...page].dart`, then it will be accessible at any path that starts with `/posts/`, with any number of levels, allowing it to called from `/posts/today`, `/posts/features/stared`, and so forth.
+
+Routing parameters are forwarded to the `onRequest` method as seen below:
+
+```dart
+import 'package:dart_frog/dart_frog.dart';
+
+Response onRequest(RequestContext context, String page) {
+  return Response(body: 'post page: $page');
+}
+```
+
+```warning
+Wildcard routes **must** be unique leaf routes on their route node, meaning that they need to be a file, and they need to be the only route in their folder.
+
 ## Route Conflicts 💥
 
 When defining routes, it's possible to encounter route conflicts.
@@ -425,11 +442,13 @@ A route conflict occurs when more than one route handler resolves to the same en
 For example, given the following file structure:
 
 ```
+
 ├── routes
 │   ├── api
 │   │   └── index.dart
 │   └── api.dart
-```
+
+````
 
 Both `routes/api/index.dart` and `routes/api.dart` resolve the the `/api` endpoint.
 
@@ -439,7 +458,7 @@ When running the development server via `dart_frog dev`, Dart Frog will report r
 [hotreload] - Application reloaded.
 
 Route conflict detected. `routes/api.dart` and `routes/api/index.dart` both resolve to `/api`.
-```
+````
 
 When generating a production build via `dart_frog build`, Dart Frog will report all detected route conflicts and fail the build if one or more route conflicts are detected.