Support basename in path generation

yesmeck · May 23, 2024 · 5d55bdf · 5d55bdf
1 parent 686a5fa
commit 5d55bdf
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -26,7 +26,10 @@ import { remixRoutes } from "remix-routes/vite";
 export default defineConfig({
   plugins: [
     remix(),
-    remixRoutes(options?)
+    remixRoutes({
+      // Optional configuration for basename
+      basename: "/basepath", // Specify the basename here
+    })
   ],
 });
 ```
@@ -35,6 +38,7 @@ Supported config options:
 
 - `strict: boolean`
 - `outDir: string`
+- `basename: string` <!---> - Specify the basename for your routes.
 
 ### Without Vite
 

diff --git a/packages/remix-routes/src/build.ts b/packages/remix-routes/src/build.ts
@@ -12,6 +12,7 @@ import { template } from './template';
 interface Options {
   strict?: boolean;
   outputDirPath: string;
+  basename?: string; // Add basename to Options interface
 }
 
 type RoutesInfo = Record<string, {
@@ -21,7 +22,7 @@ type RoutesInfo = Record<string, {
 
 export const DEFAULT_OUTPUT_DIR_PATH = './node_modules'
 
-async function buildHelpers(config: RemixConfig): Promise<[RoutesInfo, string[]]> {
+async function buildHelpers(config: RemixConfig, basename: string = ''): Promise<[RoutesInfo, string[]]> { // Add basename parameter to buildHelpers function
   const routesInfo: RoutesInfo = {};
   const routeIds: string[] = [];
   const handleRoutesRecursive = (
@@ -83,7 +84,7 @@ function expandOptionalStaticSegments(path: string) {
 }
 
 export async function build(remixRoot: string, remixConfig: RemixConfig, options: Options) {
-  const [routesInfo, routeIds] = await buildHelpers(remixConfig);
+  const [routesInfo, routeIds] = await buildHelpers(remixConfig, options.basename); // Pass basename to buildHelpers
   generate(remixRoot, remixConfig, routesInfo, routeIds, options);
 }
 
@@ -112,7 +113,7 @@ function generate(remixRoot: string, remixConfig: RemixConfig, routesInfo: Route
     strictMode: options.strict,
     relativeAppDirPath,
     routes: Object.entries(routesInfo).map(([route, { fileName, params }]) => ({
-      route,
+      route: options.basename ? `${options.basename}${route}` : route, // Prepend basename to route
       params,
       fileName: slash(fileName.replace(/\.tsx?$/, '')),
     })).sort((a, b) => a.route.localeCompare(b.route)),

diff --git a/packages/remix-routes/src/vite.ts b/packages/remix-routes/src/vite.ts
@@ -4,6 +4,7 @@ import { DEFAULT_OUTPUT_DIR_PATH, build } from './build';
 interface PluginConfig {
   strict?: boolean;
   outDir?: string;
+  basename?: string; // Add basename to PluginConfig
 }
 
 const RemixPluginContextName = '__remixPluginContext';
@@ -19,7 +20,8 @@ export function remixRoutes(pluginConfig: PluginConfig = {}): Vite.Plugin {
     if (!ctx) {
       return;
     }
-    build(rootDirectory, ctx.remixConfig, { strict: pluginConfig.strict, outputDirPath: pluginConfig.outDir || DEFAULT_OUTPUT_DIR_PATH });
+    // Utilize the basename parameter when generating paths
+    build(rootDirectory, ctx.remixConfig, { strict: pluginConfig.strict, outputDirPath: pluginConfig.outDir || DEFAULT_OUTPUT_DIR_PATH, basename: pluginConfig.basename });
   }
 
   async function reloadCtx() {
@@ -41,6 +43,10 @@ export function remixRoutes(pluginConfig: PluginConfig = {}): Vite.Plugin {
       }
       rootDirectory = config.root;
       ctx = (config as any)[RemixPluginContextName];
+      // Extract basename from the Remix plugin options and pass it to generateTypeFile
+      if (remixPlugin.options && remixPlugin.options.basename) {
+        pluginConfig.basename = remixPlugin.options.basename;
+      }
       generateTypeFile();
     },
     async watchChange(id, change) {