react-fs-router 1.0.13 → 2.0.1

package/dist/tree.js

@@ -0,0 +1,83 @@
+import { readdirSync } from "node:fs";
+import { join } from "node:path";
+import { isIgnoredName, isIndexName, isSupportedFile, parseFileName, toRouteSegment, } from "./scanner.js";
+/** Join a base route path with a segment, normalizing the leading slash. */
+export function joinPath(base, segment) {
+    if (!base || base === "/")
+        return "/" + segment;
+    return base + "/" + segment;
+}
+/**
+ * Recursively scan a pages directory and build the route tree.
+ * Directories define hierarchy, index files define the directory's page,
+ * layout (and other mapped functions) are attached as add-ons, and other
+ * files become leaf routes.
+ */
+export function scanDirectory(pages, config) {
+    return walk(pages, "", config);
+}
+function walk(dir, basePath, config) {
+    const node = {
+        type: "directory",
+        path: basePath === "" ? "/" : basePath,
+        component: null,
+        layout: null,
+        functions: {},
+        loaders: {},
+        children: [],
+    };
+    const entries = readdirSync(dir, { withFileTypes: true });
+    entries.sort((a, b) => a.name.localeCompare(b.name));
+    for (const entry of entries) {
+        if (isIgnoredName(entry.name, config))
+            continue;
+        if (entry.isDirectory()) {
+            const segment = toRouteSegment(entry.name, config.pathFormatter);
+            node.children.push(...walk(join(dir, entry.name), joinPath(basePath, segment), config));
+            continue;
+        }
+        if (!isSupportedFile(entry.name, config.extensions))
+            continue;
+        const full = join(dir, entry.name);
+        // Never scan the generated routes module itself (avoids self-imports).
+        if (full === config.outFile)
+            continue;
+        const { name } = parseFileName(entry.name);
+        const functionName = config.fileToFunction(name);
+        const loaderName = config.fileToLoader(name);
+        if (functionName === "layout") {
+            node.layout = full;
+        }
+        else if (functionName) {
+            node.functions[functionName] = full;
+        }
+        else if (loaderName) {
+            node.loaders[loaderName] = full;
+        }
+        else if (isIndexName(name)) {
+            node.component = full;
+        }
+        else {
+            node.children.push({
+                type: "file",
+                path: joinPath(basePath, toRouteSegment(name, config.pathFormatter)),
+                component: full,
+                layout: null,
+                functions: {},
+                loaders: {},
+                children: [],
+            });
+        }
+    }
+    if (basePath === "") {
+        const rootHasContent = node.component !== null ||
+            node.layout !== null ||
+            Object.keys(node.functions).length > 0 ||
+            Object.keys(node.loaders).length > 0;
+        // A content-bearing root becomes a single wrapper route; otherwise we
+        // return the top-level routes directly.
+        return rootHasContent ? [node] : node.children;
+    }
+    return [node];
+}
+//# sourceMappingURL=tree.js.map

package/dist/tree.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tree.js","sourceRoot":"","sources":["../src/tree.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AACtC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC,OAAO,EACL,aAAa,EACb,WAAW,EACX,eAAe,EACf,aAAa,EACb,cAAc,GACf,MAAM,cAAc,CAAC;AAEtB,4EAA4E;AAC5E,MAAM,UAAU,QAAQ,CAAC,IAAY,EAAE,OAAe;IACpD,IAAI,CAAC,IAAI,IAAI,IAAI,KAAK,GAAG;QAAE,OAAO,GAAG,GAAG,OAAO,CAAC;IAChD,OAAO,IAAI,GAAG,GAAG,GAAG,OAAO,CAAC;AAC9B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,KAAa,EAAE,MAAsB;IACjE,OAAO,IAAI,CAAC,KAAK,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;AACjC,CAAC;AAED,SAAS,IAAI,CAAC,GAAW,EAAE,QAAgB,EAAE,MAAsB;IACjE,MAAM,IAAI,GAAc;QACtB,IAAI,EAAE,WAAW;QACjB,IAAI,EAAE,QAAQ,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ;QACtC,SAAS,EAAE,IAAI;QACf,MAAM,EAAE,IAAI;QACZ,SAAS,EAAE,EAAE;QACb,OAAO,EAAE,EAAE;QACX,QAAQ,EAAE,EAAE;KACb,CAAC;IAEF,MAAM,OAAO,GAAG,WAAW,CAAC,GAAG,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;IAC1D,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAErD,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;QAC5B,IAAI,aAAa,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC;YAAE,SAAS;QAEhD,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;YACxB,MAAM,OAAO,GAAG,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,aAAa,CAAC,CAAC;YACjE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;YACxF,SAAS;QACX,CAAC;QAED,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,UAAU,CAAC;YAAE,SAAS;QAE9D,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;QACnC,uEAAuE;QACvE,IAAI,IAAI,KAAK,MAAM,CAAC,OAAO;YAAE,SAAS;QACtC,MAAM,EAAE,IAAI,EAAE,GAAG,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC3C,MAAM,YAAY,GAAG,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QACjD,MAAM,UAAU,GAAG,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAE7C,IAAI,YAAY,KAAK,QAAQ,EAAE,CAAC;YAC9B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACrB,CAAC;aAAM,IAAI,YAAY,EAAE,CAAC;YACxB,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC;QACtC,CAAC;aAAM,IAAI,UAAU,EAAE,CAAC;YACtB,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;QAClC,CAAC;aAAM,IAAI,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACxB,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;gBACjB,IAAI,EAAE,MAAM;gBACZ,IAAI,EAAE,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAC,IAAI,EAAE,MAAM,CAAC,aAAa,CAAC,CAAC;gBACpE,SAAS,EAAE,IAAI;gBACf,MAAM,EAAE,IAAI;gBACZ,SAAS,EAAE,EAAE;gBACb,OAAO,EAAE,EAAE;gBACX,QAAQ,EAAE,EAAE;aACb,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,IAAI,QAAQ,KAAK,EAAE,EAAE,CAAC;QACpB,MAAM,cAAc,GAClB,IAAI,CAAC,SAAS,KAAK,IAAI;YACvB,IAAI,CAAC,MAAM,KAAK,IAAI;YACpB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,GAAG,CAAC;YACtC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;QACvC,sEAAsE;QACtE,wCAAwC;QACxC,OAAO,cAAc,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;IACjD,CAAC;IAED,OAAO,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,98 @@
+export interface RouteNode {
+    /** Whether this node came from a single file ("file") or a directory ("directory"). */
+    type: "file" | "directory";
+    /** Full route path, e.g. "/about" or "/users/:id". */
+    path: string;
+    /** Absolute path to the route/index component file, or null. */
+    component: string | null;
+    /** Absolute path to the layout function file, or null. */
+    layout: string | null;
+    /** User-defined function files mapped by function name, e.g. { loading: "/abs/path.tsx" }. */
+    functions: Record<string, string>;
+    /** Data function files (loader, action, ...) mapped by name, e.g. { loader: "/abs/path.ts" }. */
+    loaders: Record<string, string>;
+    children: RouteNode[];
+}
+/** Serializable (no component references) route descriptor. */
+export interface RouteMeta {
+    type: "file" | "directory";
+    path: string;
+    component: string | null;
+    layout: string | null;
+    functions: Record<string, string>;
+    loaders: Record<string, string>;
+    children: RouteMeta[];
+}
+export type FileToFunction = (fileName: string) => string | null;
+/** Formats dynamic path segments for a specific router. */
+export interface PathFormatter {
+    /** Format a dynamic segment, e.g. `[id]` -> `:id` (react-router) or `$id` (tanstack). */
+    dynamic: (name: string) => string;
+    /** Format a catch-all segment, e.g. `[...rest]` -> `*rest`. */
+    catchAll: (name: string) => string;
+}
+export interface UserConfig {
+    /** Directory to scan for routes. Default: "src/pages". */
+    pages?: string;
+    /** Directory to write generated files to. Default: the pages directory. */
+    outDir?: string;
+    /** Name of the generated routes file. Default: "routes.tsx". */
+    outFileName?: string;
+    /** Routing adapter to target. Default: "react-router". */
+    adapter?: string;
+    /**
+     * Maps a file base name (without extension) to a function name, e.g.
+     * { layout: "layout", loading: "loading", error: "error" }.
+     * A file whose name maps to a function is treated as an add-on instead of a route.
+     */
+    functions?: Record<string, string> | FileToFunction;
+    /**
+     * Maps a file base name to a data function (loader, action, ...). These files
+     * export a function attached to the route rather than a wrapper component.
+     * Default: { loader: "loader", action: "action" }.
+     */
+    loaders?: Record<string, string> | FileToFunction;
+    /** File extensions to treat as route/function files. */
+    extensions?: string[];
+    /** Prefix that marks a file/directory as ignored. Default: "_". Set to "" to disable. */
+    ignorePrefix?: string;
+    /** Whether dot-prefixed files/directories are ignored. Default: true. */
+    ignoreDotFiles?: boolean;
+    /** Extra file/directory names to ignore. */
+    ignore?: string[];
+    /** Optional import alias prefix, e.g. "@/pages" (replaces relative imports). */
+    importPrefix?: string;
+    /**
+     * Whether a parent's layout cascades to descendants that do not define their
+     * own layout. When a descendant defines its own layout, it always overrides
+     * (replaces) the parent's layout. Default: true.
+     */
+    inheritLayout?: boolean;
+    /**
+     * Generate the legacy declarative React Router component (for use inside
+     * `<BrowserRouter>`) instead of the default data-router route objects.
+     * Default: false.
+     */
+    legacyBrowserRouter?: boolean;
+    /** Customize dynamic segment formatting (defaults come from the selected adapter). */
+    formatDynamicSegment?: (name: string) => string;
+    /** Customize catch-all segment formatting (defaults come from the selected adapter). */
+    formatCatchAllSegment?: (name: string) => string;
+}
+export interface ResolvedConfig {
+    pages: string;
+    outDir: string;
+    outFile: string;
+    adapter: string;
+    fileToFunction: FileToFunction;
+    fileToLoader: FileToFunction;
+    extensions: string[];
+    ignore: string[];
+    ignorePrefix: string;
+    ignoreDotFiles: boolean;
+    inheritLayout: boolean;
+    legacyBrowserRouter: boolean;
+    pathFormatter: PathFormatter;
+    importPrefix: string | null;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,SAAS;IACxB,uFAAuF;IACvF,IAAI,EAAE,MAAM,GAAG,WAAW,CAAC;IAC3B,sDAAsD;IACtD,IAAI,EAAE,MAAM,CAAC;IACb,gEAAgE;IAChE,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,0DAA0D;IAC1D,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,8FAA8F;IAC9F,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,iGAAiG;IACjG,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,QAAQ,EAAE,SAAS,EAAE,CAAC;CACvB;AAED,+DAA+D;AAC/D,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,GAAG,WAAW,CAAC;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,QAAQ,EAAE,SAAS,EAAE,CAAC;CACvB;AAED,MAAM,MAAM,cAAc,GAAG,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,GAAG,IAAI,CAAC;AAEjE,2DAA2D;AAC3D,MAAM,WAAW,aAAa;IAC5B,yFAAyF;IACzF,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;IAClC,+DAA+D;IAC/D,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;CACpC;AAED,MAAM,WAAW,UAAU;IACzB,0DAA0D;IAC1D,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,2EAA2E;IAC3E,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gEAAgE;IAChE,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,0DAA0D;IAC1D,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,cAAc,CAAC;IACpD;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,cAAc,CAAC;IAClD,wDAAwD;IACxD,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,yFAAyF;IACzF,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,yEAAyE;IACzE,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,4CAA4C;IAC5C,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,gFAAgF;IAChF,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,sFAAsF;IACtF,oBAAoB,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;IAChD,wFAAwF;IACxF,qBAAqB,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;CAClD;AAED,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,cAAc,CAAC;IAC/B,YAAY,EAAE,cAAc,CAAC;IAC7B,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,OAAO,CAAC;IACxB,aAAa,EAAE,OAAO,CAAC;IACvB,mBAAmB,EAAE,OAAO,CAAC;IAC7B,aAAa,EAAE,aAAa,CAAC;IAC7B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B"}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/dist/vite.d.ts

@@ -0,0 +1,14 @@
+import type { Plugin } from "vite";
+import type { UserConfig } from "./types.js";
+export interface VitePluginOptions {
+    /** Path to a config file (unused when `userConfig` is provided). */
+    config?: string;
+    /** Inline config, merged over defaults. */
+    userConfig?: UserConfig;
+}
+/**
+ * Vite plugin: generates the routes module on startup and on every change to
+ * the pages directory. Import the generated file in your app as usual.
+ */
+export declare function reactFsRouter(options?: VitePluginOptions): Plugin;
+//# sourceMappingURL=vite.d.ts.map

package/dist/vite.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vite.d.ts","sourceRoot":"","sources":["../src/vite.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAiB,MAAM,MAAM,CAAC;AAGlD,OAAO,KAAK,EAAkB,UAAU,EAAE,MAAM,YAAY,CAAC;AAE7D,MAAM,WAAW,iBAAiB;IAChC,oEAAoE;IACpE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,2CAA2C;IAC3C,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,OAAO,GAAE,iBAAsB,GAAG,MAAM,CAuBrE"}

package/dist/vite.js

@@ -0,0 +1,33 @@
+import { watch } from "chokidar";
+import { resolveConfig } from "./config.js";
+import { writeRoutes } from "./generator.js";
+/**
+ * Vite plugin: generates the routes module on startup and on every change to
+ * the pages directory. Import the generated file in your app as usual.
+ */
+export function reactFsRouter(options = {}) {
+    let resolved;
+    return {
+        name: "react-fs-router",
+        configResolved() {
+            resolved = resolveConfig(options.userConfig ?? {}, process.cwd());
+            writeRoutes(resolved);
+        },
+        buildStart() {
+            if (resolved)
+                writeRoutes(resolved);
+        },
+        configureServer(server) {
+            if (!resolved)
+                return;
+            const current = resolved;
+            const regenerate = () => {
+                writeRoutes(current);
+                server.ws.send({ type: "full-reload" });
+            };
+            const watcher = watch(current.pages, { ignored: /(^|[\/\\])\../ });
+            watcher.on("add", regenerate).on("change", regenerate).on("unlink", regenerate);
+        },
+    };
+}
+//# sourceMappingURL=vite.js.map

package/dist/vite.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vite.js","sourceRoot":"","sources":["../src/vite.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAEjC,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAU7C;;;GAGG;AACH,MAAM,UAAU,aAAa,CAAC,UAA6B,EAAE;IAC3D,IAAI,QAAoC,CAAC;IAEzC,OAAO;QACL,IAAI,EAAE,iBAAiB;QACvB,cAAc;YACZ,QAAQ,GAAG,aAAa,CAAC,OAAO,CAAC,UAAU,IAAI,EAAE,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;YAClE,WAAW,CAAC,QAAQ,CAAC,CAAC;QACxB,CAAC;QACD,UAAU;YACR,IAAI,QAAQ;gBAAE,WAAW,CAAC,QAAQ,CAAC,CAAC;QACtC,CAAC;QACD,eAAe,CAAC,MAAqB;YACnC,IAAI,CAAC,QAAQ;gBAAE,OAAO;YACtB,MAAM,OAAO,GAAG,QAAQ,CAAC;YACzB,MAAM,UAAU,GAAG,GAAS,EAAE;gBAC5B,WAAW,CAAC,OAAO,CAAC,CAAC;gBACrB,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAC;YAC1C,CAAC,CAAC;YACF,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC,CAAC;YACnE,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QAClF,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/webpack.d.ts

@@ -0,0 +1,32 @@
+import type { UserConfig } from "./types.js";
+export interface WebpackPluginOptions {
+    /** Path to a config file (unused when `userConfig` is provided). */
+    config?: string;
+    /** Inline config, merged over defaults. */
+    userConfig?: UserConfig;
+}
+interface MinimalCompiler {
+    hooks: {
+        beforeRun: {
+            tap: (name: string, fn: () => void) => void;
+        };
+        watchRun: {
+            tap: (name: string, fn: () => void) => void;
+        };
+        watchClose: {
+            tap: (name: string, fn: () => void) => void;
+        };
+    };
+}
+/**
+ * Webpack plugin: regenerates the routes module before each build/watch run
+ * and whenever a page file changes.
+ */
+export declare class ReactFsRouterWebpackPlugin {
+    private options;
+    private watcher?;
+    constructor(options?: WebpackPluginOptions);
+    apply(compiler: MinimalCompiler): void;
+}
+export {};
+//# sourceMappingURL=webpack.d.ts.map

package/dist/webpack.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webpack.d.ts","sourceRoot":"","sources":["../src/webpack.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE7C,MAAM,WAAW,oBAAoB;IACnC,oEAAoE;IACpE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,2CAA2C;IAC3C,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB;AAED,UAAU,eAAe;IACvB,KAAK,EAAE;QACL,SAAS,EAAE;YAAE,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,IAAI,KAAK,IAAI,CAAA;SAAE,CAAC;QAC3D,QAAQ,EAAE;YAAE,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,IAAI,KAAK,IAAI,CAAA;SAAE,CAAC;QAC1D,UAAU,EAAE;YAAE,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,IAAI,KAAK,IAAI,CAAA;SAAE,CAAC;KAC7D,CAAC;CACH;AAED;;;GAGG;AACH,qBAAa,0BAA0B;IAGzB,OAAO,CAAC,OAAO;IAF3B,OAAO,CAAC,OAAO,CAAC,CAA2B;gBAEvB,OAAO,GAAE,oBAAyB;IAEtD,KAAK,CAAC,QAAQ,EAAE,eAAe,GAAG,IAAI;CAavC"}

package/dist/webpack.js

@@ -0,0 +1,26 @@
+import { watch } from "chokidar";
+import { resolveConfig } from "./config.js";
+import { writeRoutes } from "./generator.js";
+/**
+ * Webpack plugin: regenerates the routes module before each build/watch run
+ * and whenever a page file changes.
+ */
+export class ReactFsRouterWebpackPlugin {
+    options;
+    watcher;
+    constructor(options = {}) {
+        this.options = options;
+    }
+    apply(compiler) {
+        const config = resolveConfig(this.options.userConfig ?? {}, process.cwd());
+        const generate = () => {
+            writeRoutes(config);
+        };
+        compiler.hooks.beforeRun.tap("ReactFsRouterWebpackPlugin", generate);
+        compiler.hooks.watchRun.tap("ReactFsRouterWebpackPlugin", generate);
+        compiler.hooks.watchClose.tap("ReactFsRouterWebpackPlugin", () => this.watcher?.close());
+        this.watcher = watch(config.pages, { ignored: /(^|[\/\\])\../ });
+        this.watcher.on("add", generate).on("change", generate).on("unlink", generate);
+    }
+}
+//# sourceMappingURL=webpack.js.map

package/dist/webpack.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"webpack.js","sourceRoot":"","sources":["../src/webpack.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACjC,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAkB7C;;;GAGG;AACH,MAAM,OAAO,0BAA0B;IAGjB;IAFZ,OAAO,CAA4B;IAE3C,YAAoB,UAAgC,EAAE;QAAlC,YAAO,GAAP,OAAO,CAA2B;IAAG,CAAC;IAE1D,KAAK,CAAC,QAAyB;QAC7B,MAAM,MAAM,GAAG,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,IAAI,EAAE,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;QAC3E,MAAM,QAAQ,GAAG,GAAS,EAAE;YAC1B,WAAW,CAAC,MAAM,CAAC,CAAC;QACtB,CAAC,CAAC;QAEF,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,4BAA4B,EAAE,QAAQ,CAAC,CAAC;QACrE,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,4BAA4B,EAAE,QAAQ,CAAC,CAAC;QACpE,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,4BAA4B,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;QAEzF,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC,CAAC;QACjE,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACjF,CAAC;CACF"}

package/package.json

@@ -1,35 +1,103 @@
-{
-  "name": "react-fs-router",
-  "version": "1.0.13",
-  "description": "File-system based routing for React.",
-  "main": "./index.js",
-  "git repository": "https://github.com/Mehran9675/react-filesystem-routing",
-  "scripts": {
-    "test": "node ./index.js -i ./pages -ext ts",
-    "build": "npx -p typescript tsc"
-  },
-  "keywords": [
-    "react",
-    "file-system",
-    "routing",
-    "react-pages"
-  ],
-  "author": "Mehran Zahiroddini",
-  "license": "MIT",
-  "dependencies": {
-    "chokidar": "^3.5.2",
-    "commander": "^8.2.0"
-  },
-  "bin": {
-    "react-fs-router": "./index.js",
-    "rfr": "./index.js"
-  },
-  "devDependencies": {
-    "typescript": "^4.4.4",
-    "prettier": "^2.4.1"
-  }
-  ,"repository": {
-    "type":"git",
-    "url":"https://github.com/Mehran9675/react-filesystem-routing"
-  }
-}
+{
+  "name": "react-fs-router",
+  "version": "2.0.1",
+  "description": "Config-driven, adapter-pluggable file-system routing for React.",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./render": {
+      "types": "./dist/render.d.ts",
+      "import": "./dist/render.js"
+    },
+    "./vite": {
+      "types": "./dist/vite.d.ts",
+      "import": "./dist/vite.js"
+    },
+    "./webpack": {
+      "types": "./dist/webpack.d.ts",
+      "import": "./dist/webpack.js"
+    },
+    "./adapters/react-router": {
+      "types": "./dist/adapters/react-router.d.ts",
+      "import": "./dist/adapters/react-router.js"
+    },
+    "./adapters/custom": {
+      "types": "./dist/adapters/custom.d.ts",
+      "import": "./dist/adapters/custom.js"
+    },
+    "./adapters/tanstack": {
+      "types": "./dist/adapters/tanstack.d.ts",
+      "import": "./dist/adapters/tanstack.js"
+    }
+  },
+  "bin": {
+    "react-fs-router": "./dist/cli.js",
+    "rfr": "./dist/cli.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "pretest": "npm run build",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "keywords": [
+    "react",
+    "file-system",
+    "routing",
+    "react-router",
+    "tanstack-router",
+    "vite",
+    "webpack"
+  ],
+  "author": "Mehran Zahiroddini",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Mehran9675/react-filesystem-routing"
+  },
+  "dependencies": {
+    "chokidar": "^3.6.0",
+    "commander": "^12.1.0"
+  },
+  "peerDependencies": {
+    "react": ">=17",
+    "react-router": ">=7",
+    "@tanstack/react-router": ">=1"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    },
+    "react-router": {
+      "optional": true
+    },
+    "@tanstack/react-router": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@tanstack/react-router": "^1.170.33",
+    "@testing-library/react": "^16.1.0",
+    "@types/node": "^22.10.2",
+    "@types/react": "^18.3.12",
+    "@types/react-dom": "^18.3.1",
+    "esbuild-loader": "^4.2.2",
+    "jsdom": "^25.0.1",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "react-router": "^7.0.0",
+    "typescript": "^5.7.2",
+    "vite": "^5.4.11",
+    "vitest": "^2.1.8",
+    "webpack": "^5.95.0"
+  }
+}

package/.idea/git_toolbox_prj.xml

@@ -1,15 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="GitToolBoxProjectSettings">
-    <option name="commitMessageIssueKeyValidationOverride">
-      <BoolValueOverride>
-        <option name="enabled" value="true" />
-      </BoolValueOverride>
-    </option>
-    <option name="commitMessageValidationEnabledOverride">
-      <BoolValueOverride>
-        <option name="enabled" value="true" />
-      </BoolValueOverride>
-    </option>
-  </component>
-</project>

package/.idea/modules.xml

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectModuleManager">
-    <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/react-filesystem-router.iml" filepath="$PROJECT_DIR$/.idea/react-filesystem-router.iml" />
-    </modules>
-  </component>
-</project>

package/.idea/react-filesystem-router.iml

@@ -1,12 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="WEB_MODULE" version="4">
-  <component name="NewModuleRootManager">
-    <content url="file://$MODULE_DIR$">
-      <excludeFolder url="file://$MODULE_DIR$/temp" />
-      <excludeFolder url="file://$MODULE_DIR$/.tmp" />
-      <excludeFolder url="file://$MODULE_DIR$/tmp" />
-    </content>
-    <orderEntry type="inheritedJdk" />
-    <orderEntry type="sourceFolder" forTests="false" />
-  </component>
-</module>

package/.idea/vcs.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="$PROJECT_DIR$" vcs="Git" />
-  </component>
-</project>