allow hyphens in polyvariant path params

zth · Aug 19, 2024 · 41607a6 · 41607a6
1 parent 06b041a
commit 41607a6
Show file tree

Hide file tree

Showing 13 changed files with 33 additions and 22 deletions.
diff --git a/.changeset/green-parrots-work.md b/.changeset/green-parrots-work.md
@@ -0,0 +1,5 @@
+---
+"rescript-relay-router": patch
+---
+
+Allow hyphens in polyvariant match branches.
diff --git a/examples/client-rendering/src/routes/Root__Todos__ByStatus_route_renderer.res b/examples/client-rendering/src/routes/Root__Todos__ByStatus_route_renderer.res
@@ -2,7 +2,13 @@ let renderer = Routes.Root.Todos.ByStatus.Route.makeRenderer(
   ~prepare=_props => {
     ()
   },
-  ~render=_props => {
-    React.null
+  ~render=props => {
+    <>
+      {switch props.byStatus {
+      | #completed => React.string("YES")
+      | #"not-completed" => React.string("NOT COMPLETED")
+      }}
+      {React.string((props.byStatus :> string))}
+    </>
   },
 )
diff --git a/examples/client-rendering/src/routes/__generated__/RouteDeclarations.res b/examples/client-rendering/src/routes/__generated__/RouteDeclarations.res
diff --git a/examples/client-rendering/src/routes/__generated__/Route__Root__Todos__ByStatus_route.res b/examples/client-rendering/src/routes/__generated__/Route__Root__Todos__ByStatus_route.res
diff --git a/examples/client-rendering/src/routes/__generated__/Route__Root__Todos_route.res b/examples/client-rendering/src/routes/__generated__/Route__Root__Todos_route.res
diff --git a/examples/client-rendering/src/routes/__generated__/Route__Root_route.res b/examples/client-rendering/src/routes/__generated__/Route__Root_route.res
diff --git a/examples/client-rendering/src/routes/todoRoutes.json b/examples/client-rendering/src/routes/todoRoutes.json
@@ -4,7 +4,7 @@
     "name": "Todos",
     "children": [
       {
-        "path": ":byStatus(completed|notCompleted)",
+        "path": ":byStatus(completed|not-completed)",
         "name": "ByStatus",
         "children": []
       },

diff --git a/examples/express/src/routes/__generated__/Route__Root__Todos__ByStatus_route.res b/examples/express/src/routes/__generated__/Route__Root__Todos__ByStatus_route.res
diff --git a/examples/express/src/routes/__generated__/Route__Root__Todos_route.res b/examples/express/src/routes/__generated__/Route__Root__Todos_route.res
diff --git a/examples/express/src/routes/__generated__/Route__Root_route.res b/examples/express/src/routes/__generated__/Route__Root_route.res
diff --git a/packages/rescript-relay-router/cli/RescriptRelayRouterCli__Parser.res b/packages/rescript-relay-router/cli/RescriptRelayRouterCli__Parser.res
@@ -387,12 +387,12 @@ module Path = {
             )
           }
         | _ =>
-          switch %re(`/[A-Za-z0-9_]/`)->RegExp.test(char) {
+          switch %re(`/[A-Za-z0-9_\-]/`)->RegExp.test(char) {
           | true => ()
           | false =>
             ctx.addDecodeError(
               ~loc=charLoc,
-              ~message=`"${char}" is not a valid character in a path match branch. Path match branches can contain letters, digits, and underscores.`,
+              ~message=`"${char}" is not a valid character in a path match branch. Path match branches can contain letters, digits, underscores and hyphens.`,
             )
           }
         }

diff --git a/packages/rescript-relay-router/cli/RescriptRelayRouterCli__Utils.res b/packages/rescript-relay-router/cli/RescriptRelayRouterCli__Utils.res
@@ -146,7 +146,7 @@ let printablePathParamToTypeStr = p =>
   | PrintableRegularPathParam({?pathToCustomModuleWithTypeT}) =>
     pathToCustomModuleWithTypeT->Option.getOr("string")
   | PrintablePathParamWithMatchBranches({matchArms}) =>
-    `[${matchArms->Array.map(b => `#${b}`)->Array.join(" | ")}]`
+    `[${matchArms->Array.map(b => `#"${b}"`)->Array.join(" | ")}]`
   }
 
 let printablePathParamToParamName = p =>

diff --git a/packages/rescript-relay-router/src/vendor/react-router.js b/packages/rescript-relay-router/src/vendor/react-router.js
@@ -267,7 +267,7 @@ function compilePath(path, caseSensitive = false, end = true) {
       .replace(/\/*\*?$/, "") // Ignore trailing / and /*, we'll handle it below
       .replace(/^\/*/, "/") // Make sure it has a leading /
       .replace(/[\\.*+^$?{}[\]]/g, "\\$&") // Escape special regex chars
-      .replace(/:([\w(|)]+)/g, (_, paramName) => {
+      .replace(/:([\w(|)-]+)/g, (_, paramName) => {
         // Check if this is a regexp param. If so, special treatment.
         if (paramName.endsWith(")")) {
           let [pname, regexp] = paramName.slice(0, -1).split("(");