Support optional route params (#32)

* Support optional route params

* Fix route function to strip optional params syntax

* feat(routes-gen): polish optional params support

Co-authored-by: Stratulat Alexandru <[email protected]>

Author: brandonpittman

packages/routes-gen-remix/package.json

@@ -22,7 +22,7 @@
     "routes-gen": "*"
   },
   "devDependencies": {
-    "@remix-run/dev": "^1.0.3",
+    "@remix-run/dev": "^1.9.0",
     "config": "*"
   },
   "peerDependencies": {

packages/routes-gen/src/export-routes.ts

@@ -23,9 +23,17 @@ export const exportRoutes = ({
     .map((route) => {
       const params = extractPathParams(route.path);
 
+      const onlyOptionalParams =
+        params.length > 0 && params.every((param) => param.endsWith("?"));
+
       return `      | ["${route.path}"${
         params.length > 0 ? `, RouteParams["${route.path}"]` : ""
-      }]`;
+      }]${
+        onlyOptionalParams
+          ? `
+      | ["${route.path}"]`
+          : ""
+      }`;
     })
     .join("\n");
 
@@ -35,7 +43,13 @@ export const exportRoutes = ({
 
       return `    "${route.path}": ${
         params.length > 0
-          ? `{ ${params.map((path) => `"${path}": string`).join(", ")} }`
+          ? `{ ${params
+              .map((param) =>
+                param.endsWith("?")
+                  ? `"${param.slice(0, -1)}"?: string`
+                  : `"${param}": string`
+              )
+              .join(", ")} }`
           : "Record<string, never>"
       };`;
     })

packages/routes-gen/src/route.ts

@@ -3,11 +3,13 @@ export function route<T extends string>(
   params?: Record<string, any>
 ): T {
   if (params) {
-    return Object.entries(params).reduce(
-      (result, [key, value]) =>
-        result.replace(new RegExp(`:${key}`, "g"), value),
-      path as string
-    ) as T;
+    return Object.entries(params)
+      .reduce(
+        (result, [key, value]) =>
+          result.replace(new RegExp(`:${key}\\??`, "g"), value),
+        path as string
+      )
+      .replace(new RegExp("\\/:.+\\?", "g"), "") as T;
   }
 
   return path;