@troyio/vite-file-router 0.3.0 → 0.3.2

package/README.md

@@ -108,6 +108,12 @@ Catch-all segments such as `[...slug]` become `*`. Parenthesized directories
 are route groups; they organize files and can have their own page, layout,
 loading files, loaders, and actions, but their names do not add a URL segment.
 
+Directories whose names start with an underscore, such as `_components` or
+`_utils`, are private folders. The plugin skips them and everything nested
+inside them, so you can colocate components, hooks, and helpers next to the
+routes that use them without creating routes. A `_components/page.tsx` file is
+never routed.
+
 ### Layouts
 
 The plugin adapts React Router's matched child route to a `children` prop. A
@@ -178,6 +184,23 @@ when a descendant URL matches. An action runs only when its route is selected
 as the submission target; a parent action does not automatically handle
 submissions targeting child routes.
 
+A loader module may also export `shouldRevalidate(args)` to control the route's
+React Router `shouldRevalidate` option. It receives the same arguments as
+`shouldRevalidate` and must synchronously return a boolean:
+
+```ts
+import type { LoaderFunctionArgs, ShouldRevalidateFunctionArgs } from "react-router";
+
+export function shouldRevalidate({ nextUrl, defaultShouldRevalidate }: ShouldRevalidateFunctionArgs) {
+  if (nextUrl.searchParams.get("refresh") === "never") return false;
+  return defaultShouldRevalidate;
+}
+
+export async function loader({ request }: LoaderFunctionArgs) {
+  return getDashboardData(request);
+}
+```
+
 Use a loader to redirect users who should not enter a protected route subtree.
 For example, `src/pages/dashboard/loader.ts` can guard `/dashboard` and all of
 its nested pages:

package/dist/index.js

@@ -53,6 +53,7 @@ function scan(directory, conventions = DEFAULT_CONVENTIONS) {
 	for (const entry of entries) {
 		const file = path.join(directory, entry.name);
 		if (entry.isDirectory()) {
+			if (entry.name.startsWith("_")) continue;
 			node.children.push(scan(file, conventions));
 			continue;
 		}
@@ -132,9 +133,19 @@ function generateImport(file, projectRoot) {
     Component: (await import(${JSON.stringify(getImportPath(file, projectRoot))})).default
   })`;
 }
-function generateRouteLazy(node, projectRoot, includeLayout) {
+function generateRouteLazy(node, projectRoot, includeLayout, includeLoader) {
 	const properties = [];
 	if (includeLayout && node.layout) properties.push(`Component: withOutlet((await import(${JSON.stringify(getImportPath(node.layout, projectRoot))})).default)`);
+	if (includeLoader && node.loader) return `async () => {
+      const loaderModule = await import(${JSON.stringify(getImportPath(node.loader, projectRoot))});
+      return {
+        loader: loaderModule.loader,
+        ...(typeof loaderModule.shouldRevalidate === "function"
+          ? { shouldRevalidate: loaderModule.shouldRevalidate }
+          : {}),
+        ${properties.join(",\n        ")}
+      };
+    }`;
 	return `async () => ({ ${properties.join(", ")} })`;
 }
 function generateLazyComponent(file, projectRoot) {
@@ -143,8 +154,8 @@ function generateLazyComponent(file, projectRoot) {
 function generateLazyLayout(file, projectRoot) {
 	return `lazy(() => import(${JSON.stringify(getImportPath(file, projectRoot))}).then(({ default: Layout }) => ({ default: withOutlet(Layout) })))`;
 }
-function generateDataHandler(file, kind, projectRoot) {
-	return `async (args) => (await import(${JSON.stringify(getImportPath(file, projectRoot))})).${kind}(args)`;
+function generateDataHandler(file, projectRoot) {
+	return `async (args) => (await import(${JSON.stringify(getImportPath(file, projectRoot))})).action(args)`;
 }
 function getRouteId(directory, projectRoot) {
 	return `file-route:${path.relative(projectRoot, directory).split(path.sep).join("/") || "."}`;
@@ -159,8 +170,7 @@ function generateNode(node, root, context, inheritedBoundary) {
 		context.hasErrorBoundaries = true;
 		route.ErrorBoundary = `createErrorBoundary(${generateLazyComponent(node.error, context.projectRoot)})`;
 	}
-	if (node.loader) route.loader = generateDataHandler(node.loader, "loader", context.projectRoot);
-	if (node.action) route.action = generateDataHandler(node.action, "action", context.projectRoot);
+	if (node.action) route.action = generateDataHandler(node.action, context.projectRoot);
 	let loadingComponent;
 	if (node.loading) {
 		loadingComponent = genSafeVariableName(`Loading${context.nextLoadingId++}`);
@@ -173,17 +183,17 @@ function generateNode(node, root, context, inheritedBoundary) {
 	} else if (node.layout) {
 		if (hasBoundary) route.Component = generateLazyLayout(node.layout, context.projectRoot);
 	}
-	if (node.layout && !hasBoundary) route.lazy = generateRouteLazy(node, context.projectRoot, true);
+	if (node.layout && !hasBoundary || node.loader) route.lazy = generateRouteLazy(node, context.projectRoot, Boolean(node.layout && !hasBoundary), Boolean(node.loader));
 	const children = [];
 	if (node.page) {
 		const page = hasBoundary ? {
 			index: "true",
 			Component: generateLazyComponent(node.page, context.projectRoot),
-			...node.action ? { action: generateDataHandler(node.action, "action", context.projectRoot) } : {}
+			...node.action ? { action: generateDataHandler(node.action, context.projectRoot) } : {}
 		} : {
 			index: "true",
 			lazy: generateImport(node.page, context.projectRoot),
-			...node.action ? { action: generateDataHandler(node.action, "action", context.projectRoot) } : {}
+			...node.action ? { action: generateDataHandler(node.action, context.projectRoot) } : {}
 		};
 		children.push(genObjectFromRaw(page));
 	}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@troyio/vite-file-router",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "description": "File-system routing plugin for Vite",
   "type": "module",
   "private": false,