uidex 0.8.0 → 0.9.0

package/dist/scan/index.d.cts

@@ -153,7 +153,18 @@ interface SourceConfig {
 interface ConventionsConfig {
     primitives?: string[] | false;
     features?: string | false;
-    pages?: "auto" | false;
+    /**
+     * How Page entities are derived from route files.
+     *   - `"auto"` (default): infer the route root from the `app`/`pages`/
+     *     `routes` directory-name heuristic.
+     *   - `{ routesDir }`: the route root is exactly this dir (relative to the
+     *     config dir), detected with the TanStack / React Router `routes/`-style
+     *     convention. Use for a custom TanStack `routesDirectory`.
+     *   - `false`: do not derive pages from routes.
+     */
+    pages?: "auto" | false | {
+        routesDir: string;
+    };
     flows?: string[] | false;
     regions?: "landmarks" | false;
 }
@@ -611,10 +622,26 @@ declare function emit(opts: EmitOptions): EmitResult;
  * Detect framework-aware routes:
  *   - Next.js App Router:    `**\/app/**\/page.tsx` -> `/segments`
  *   - Next.js Pages Router:  `**\/pages/**\/*.tsx`  -> `/segments` (excludes _app, _document, api/)
- *   - Vite + React Router / TanStack Router:
- *                            `**\/routes/**\/*.tsx` -> `/segments`
+ *   - Vite + TanStack Router / React Router: `**\/routes/**\/*.tsx` -> `/segments`.
+ *     Honors TanStack conventions: pathless layouts (`_layout`) and route
+ *     groups (`(group)`) drop from the path, the folder route file
+ *     (`route.tsx`) collapses like `index`, `-`-prefixed and `api/` files are
+ *     excluded, and flat dot-notation filenames (`a.b.$c.tsx`) split into
+ *     nested segments. Dynamic segments are normalized to the canonical
+ *     `[param]` form used everywhere else in the pipeline: `$id` -> `[id]`,
+ *     the splat `$` -> `[...splat]`, and `[.]`-escaped literals are unwrapped.
  */
-declare function detectRoutes(files: ScannedFile[]): DetectedRoute[];
+interface DetectRoutesOptions {
+    /**
+     * Explicit routes root, as it appears in `displayPath` (relative to the
+     * config dir). When set, only files under this dir are routes and the
+     * TanStack / React Router `routes/`-style convention is applied — overriding
+     * the `app`/`pages`/`routes` directory-name heuristic. Use for a custom
+     * TanStack `routesDirectory`.
+     */
+    routesDir?: string;
+}
+declare function detectRoutes(files: ScannedFile[], options?: DetectRoutesOptions): DetectedRoute[];
 declare function pathToId(routePath: string): string;
 
 interface GitResolveOptions {

package/dist/scan/index.d.ts

@@ -153,7 +153,18 @@ interface SourceConfig {
 interface ConventionsConfig {
     primitives?: string[] | false;
     features?: string | false;
-    pages?: "auto" | false;
+    /**
+     * How Page entities are derived from route files.
+     *   - `"auto"` (default): infer the route root from the `app`/`pages`/
+     *     `routes` directory-name heuristic.
+     *   - `{ routesDir }`: the route root is exactly this dir (relative to the
+     *     config dir), detected with the TanStack / React Router `routes/`-style
+     *     convention. Use for a custom TanStack `routesDirectory`.
+     *   - `false`: do not derive pages from routes.
+     */
+    pages?: "auto" | false | {
+        routesDir: string;
+    };
     flows?: string[] | false;
     regions?: "landmarks" | false;
 }
@@ -611,10 +622,26 @@ declare function emit(opts: EmitOptions): EmitResult;
  * Detect framework-aware routes:
  *   - Next.js App Router:    `**\/app/**\/page.tsx` -> `/segments`
  *   - Next.js Pages Router:  `**\/pages/**\/*.tsx`  -> `/segments` (excludes _app, _document, api/)
- *   - Vite + React Router / TanStack Router:
- *                            `**\/routes/**\/*.tsx` -> `/segments`
+ *   - Vite + TanStack Router / React Router: `**\/routes/**\/*.tsx` -> `/segments`.
+ *     Honors TanStack conventions: pathless layouts (`_layout`) and route
+ *     groups (`(group)`) drop from the path, the folder route file
+ *     (`route.tsx`) collapses like `index`, `-`-prefixed and `api/` files are
+ *     excluded, and flat dot-notation filenames (`a.b.$c.tsx`) split into
+ *     nested segments. Dynamic segments are normalized to the canonical
+ *     `[param]` form used everywhere else in the pipeline: `$id` -> `[id]`,
+ *     the splat `$` -> `[...splat]`, and `[.]`-escaped literals are unwrapped.
  */
-declare function detectRoutes(files: ScannedFile[]): DetectedRoute[];
+interface DetectRoutesOptions {
+    /**
+     * Explicit routes root, as it appears in `displayPath` (relative to the
+     * config dir). When set, only files under this dir are routes and the
+     * TanStack / React Router `routes/`-style convention is applied — overriding
+     * the `app`/`pages`/`routes` directory-name heuristic. Use for a custom
+     * TanStack `routesDirectory`.
+     */
+    routesDir?: string;
+}
+declare function detectRoutes(files: ScannedFile[], options?: DetectRoutesOptions): DetectedRoute[];
 declare function pathToId(routePath: string): string;
 
 interface GitResolveOptions {

package/dist/scan/index.js

@@ -135,7 +135,13 @@ function validateConfig(raw) {
       fail(`conventions.features must be a string or false`);
     }
     if (c.pages !== void 0 && c.pages !== false && c.pages !== "auto") {
-      fail(`conventions.pages must be "auto" or false`);
+      const p2 = c.pages;
+      const routesDir = typeof p2 === "object" && p2 !== null && !Array.isArray(p2) ? p2.routesDir : void 0;
+      if (typeof p2 !== "object" || p2 === null || Array.isArray(p2) || Object.keys(p2).some((k) => k !== "routesDir") || typeof routesDir !== "string" || routesDir.length === 0) {
+        fail(
+          `conventions.pages must be "auto", false, or { routesDir: string }`
+        );
+      }
     }
     if (c.flows !== void 0 && c.flows !== false) {
       assertStringArray(c.flows, "conventions.flows");
@@ -1820,13 +1826,26 @@ import * as path4 from "path";
 var PAGE_BASENAME = /^page\.(tsx|ts|jsx|js|mjs|cjs)$/;
 var PAGES_ROUTER_BASENAME = /\.(tsx|ts|jsx|js|mjs|cjs)$/;
 var ROUTE_BASENAME = /^route\.(tsx|ts|jsx|js|mjs|cjs)$/;
-function detectRoutes(files) {
+function detectRoutes(files, options = {}) {
   const out2 = [];
   const seen = /* @__PURE__ */ new Set();
+  const routesDir = options.routesDir ? options.routesDir.replace(/^\.?\/+/, "").replace(/\/+$/, "") : null;
+  const routesDirParts = routesDir ? routesDir.split("/") : null;
   for (const f of files) {
     const rel = f.displayPath;
     const parts = rel.split("/");
     const base = parts[parts.length - 1];
+    if (routesDirParts) {
+      const end = dirEndIndex(parts, routesDirParts);
+      if (end === -1 || end > parts.length - 1) continue;
+      if (!PAGES_ROUTER_BASENAME.test(base)) continue;
+      const routePath = routesStylePath(
+        parts.slice(end, parts.length - 1),
+        base
+      );
+      if (routePath !== null) push(out2, seen, routePath, f.displayPath);
+      continue;
+    }
     const appIdx = parts.indexOf("app");
     if (appIdx !== -1 && PAGE_BASENAME.test(base)) {
       const routeSegments = parts.slice(appIdx + 1, parts.length - 1);
@@ -1853,15 +1872,11 @@ function detectRoutes(files) {
     }
     const routesIdx = parts.indexOf("routes");
     if (routesIdx !== -1 && PAGES_ROUTER_BASENAME.test(base)) {
-      const segs = parts.slice(routesIdx + 1);
-      const last = segs[segs.length - 1];
-      if (last.startsWith("_")) continue;
-      const normalized = [
-        ...segs.slice(0, -1),
-        base.replace(/\.[^.]+$/, "")
-      ].filter((s) => s !== "index" && s !== "__root");
-      const routePath = formatNextAppPath(normalized);
-      push(out2, seen, routePath, f.displayPath);
+      const routePath = routesStylePath(
+        parts.slice(routesIdx + 1, parts.length - 1),
+        base
+      );
+      if (routePath !== null) push(out2, seen, routePath, f.displayPath);
       continue;
     }
   }
@@ -1877,6 +1892,63 @@ function formatNextAppPath(segments) {
   if (kept.length === 0) return "/";
   return "/" + kept.join("/");
 }
+function dirEndIndex(parts, dirParts) {
+  if (dirParts.length === 0) return 0;
+  for (let i = 0; i + dirParts.length <= parts.length; i++) {
+    let match = true;
+    for (let j = 0; j < dirParts.length; j++) {
+      if (parts[i + j] !== dirParts[j]) {
+        match = false;
+        break;
+      }
+    }
+    if (match) return i + dirParts.length;
+  }
+  return -1;
+}
+function routesStylePath(dirSegs, base) {
+  const fileSegs = splitFlatSegments(base.replace(/\.[^.]+$/, ""));
+  const leaf = fileSegs[fileSegs.length - 1];
+  if (leaf.startsWith("_")) return null;
+  const rawSegs = [...dirSegs, ...fileSegs];
+  if (rawSegs.some((s) => s.startsWith("-"))) return null;
+  if (rawSegs[0] === "api") return null;
+  return formatTanStackPath(rawSegs);
+}
+function splitFlatSegments(name) {
+  const segs = [];
+  let cur = "";
+  let depth = 0;
+  for (const ch of name) {
+    if (ch === "[") depth++;
+    else if (ch === "]") depth = Math.max(0, depth - 1);
+    if (ch === "." && depth === 0) {
+      segs.push(cur);
+      cur = "";
+      continue;
+    }
+    cur += ch;
+  }
+  segs.push(cur);
+  return segs;
+}
+function formatTanStackPath(segments) {
+  const kept = [];
+  for (const seg of segments) {
+    if (!seg) continue;
+    if (seg === "index" || seg === "route" || seg === "__root") continue;
+    if (seg.startsWith("_")) continue;
+    if (seg.startsWith("(") && seg.endsWith(")")) continue;
+    kept.push(normalizeTanStackSegment(seg.replace(/_$/, "")));
+  }
+  if (kept.length === 0) return "/";
+  return "/" + kept.join("/");
+}
+function normalizeTanStackSegment(seg) {
+  if (seg === "$") return "[...splat]";
+  if (seg.startsWith("$")) return `[${seg.slice(1)}]`;
+  return seg.replace(/\[([^\]]*)\]/g, "$1");
+}
 function pathToId(routePath) {
   if (routePath === "/") return "root";
   return routePath.replace(/^\/+/, "").replace(/\[\.{3}([^\]]+)\]/g, "$1").replace(/\[([^\]]+)\]/g, "$1").replace(/\//g, "-").replace(/[^a-zA-Z0-9-]/g, "-").replace(/-+/g, "-").replace(/^-|-$/g, "");
@@ -1972,9 +2044,12 @@ function resolve2(ctx) {
   function metaWithComposes(kind, id, base) {
     const composes = directChildren.get(`${kind}:${id}`);
     if (!composes || composes.length === 0) return base;
-    return { ...base ?? {}, composes };
+    return { ...base, composes };
   }
-  const routes = conventions.pages === "auto" ? detectRoutes(ctx.extracted.map((e) => e.file)) : [];
+  const routes = conventions.pages === false ? [] : detectRoutes(
+    ctx.extracted.map((e) => e.file),
+    conventions.pages === "auto" ? {} : { routesDir: conventions.pages.routesDir }
+  );
   const handledPageFiles = /* @__PURE__ */ new Set();
   for (const route of routes) {
     const routeDir = path4.posix.dirname(route.file);