@ubean/routing 0.1.7 → 0.1.8

package/dist/generator/index.d.ts

@@ -18,6 +18,15 @@ import { ScanResult, ScannedLayout, ScannedPageRoute } from "../types.js";
 interface GeneratorOptions {
   /** Project root directory (absolute). */
   cwd: string;
+  /**
+   * Source directory (absolute, defaults to `<cwd>/src`).
+   *
+   * Used by the default `getImportPath` / `getLayoutImportPath` to compute
+   * import specifiers relative to `srcDir` (the conventional target of the
+   * `@/` path alias). When the alias differs, supply custom `getImportPath` /
+   * `getLayoutImportPath` callbacks.
+   */
+  srcDir?: string;
   /** Output directory for `routes.ts` / `imports.ts` (absolute or relative to `cwd`). */
   outDir: string;
   /** Path for `typed-router.d.ts` (absolute or relative to `cwd`). Default: `<outDir>/typed-router.d.ts`. */
@@ -41,7 +50,8 @@ interface GeneratorOptions {
   /**
    * Compute the import specifier for a page file. Receives the absolute
    * `fullPath` of the page; should return a module specifier usable from
-   * `imports.ts`. Defaults to a project-relative path prefixed with `@/`.
+   * `imports.ts`. Defaults to a `srcDir`-relative path prefixed with `@/`
+   * (e.g. `@/pages/about.vue`), matching the common `@/` → `src/` alias.
    */
   getImportPath?: (page: ScannedPageRoute) => string;
   /** Same as `getImportPath` but for layouts. */

package/dist/generator/index.js

@@ -9,6 +9,7 @@ var RouteFileGenerator = class {
 		const dtsPath = options.dtsPath ?? joinPosix(options.outDir, "typed-router.d.ts");
 		this.opts = {
 			cwd: options.cwd,
+			srcDir: options.srcDir ?? joinPosix(options.cwd, "src"),
 			outDir: options.outDir,
 			dtsPath,
 			generateRoutes: options.generateRoutes ?? true,
@@ -52,23 +53,23 @@ ${scanResult.pages.map((p) => this.renderRouteRecord(p)).join(",\n")}
 	}
 	renderRouteRecord(page) {
 		const parts = [];
-		parts.push(`  name: ${JSON.stringify(page.name)}`);
-		parts.push(`  path: ${JSON.stringify(page.route)}`);
-		const component = this.opts.getImportPath?.(page) ?? defaultPageImportPath(page, this.opts.cwd);
-		parts.push(`  component: ${JSON.stringify(component)}`);
+		parts.push(`    name: ${JSON.stringify(page.name)}`);
+		parts.push(`    path: ${JSON.stringify(page.route)}`);
+		const componentKey = page.isReuse && page.reuseTarget ? page.reuseTarget : page.name;
+		parts.push(`    component: ${JSON.stringify(componentKey)}`);
 		if (page.layout !== void 0) {
 			const layoutVal = page.layout === false ? "false" : JSON.stringify(page.layout);
-			parts.push(`  layout: ${layoutVal}`);
+			parts.push(`    layout: ${layoutVal}`);
 		}
-		if (page.isReuse) parts.push(`  reuse: true`);
+		if (page.isReuse) parts.push(`    reuse: true`);
 		const meta = this.computeMeta(page);
-		if (meta && Object.keys(meta).length > 0) parts.push(`  meta: ${JSON.stringify(meta)}`);
-		if (page.pageMeta?.cache === true) parts.push(`  cache: true`);
-		if (page.pageMeta?.requiresAuth === true) parts.push(`  requiresAuth: true`);
+		if (meta && Object.keys(meta).length > 0) parts.push(`    meta: ${JSON.stringify(meta)}`);
+		if (page.pageMeta?.cache === true) parts.push(`    cache: true`);
+		if (page.pageMeta?.requiresAuth === true) parts.push(`    requiresAuth: true`);
 		if (page.pageMeta?.middleware) {
 			const mw = page.pageMeta.middleware;
 			const mwVal = Array.isArray(mw) ? JSON.stringify(mw) : JSON.stringify(mw);
-			parts.push(`  middleware: ${mwVal}`);
+			parts.push(`    middleware: ${mwVal}`);
 		}
 		return `  {\n${parts.join(",\n")}\n  }`;
 	}
@@ -84,10 +85,39 @@ ${scanResult.pages.map((p) => this.renderRouteRecord(p)).join(",\n")}
 		const header = this.opts.headerComment;
 		const layouts = scanResult.layouts.map((l) => this.renderLayoutImport(l)).join(",\n");
 		const views = scanResult.pages.filter((p) => !p.isReuse).map((p) => this.renderViewImport(p)).join(",\n");
+		const layoutType = scanResult.layouts.length > 0 ? `'${scanResult.layouts.map((l) => l.name).join("' | '")}'` : "string";
+		const filePages = scanResult.pages.filter((p) => !p.isReuse);
+		const reusePages = scanResult.pages.filter((p) => p.isReuse);
 		return `${header}
 
-export type LayoutKey = ${scanResult.layouts.length > 0 ? `'${scanResult.layouts.map((l) => l.name).join("' | '")}'` : "string"};
-export type RouteKey = ${scanResult.pages.length > 0 ? `'${scanResult.pages.map((p) => p.name).join("' | '")}'` : "string"};
+export type LayoutKey = ${layoutType};
+
+/**
+ * Route keys that have a corresponding source file (\`.vue\` / \`.md\`).
+ * Excludes reuse routes and builtin routes.
+ *
+ * The \`views\` map is keyed by this type — \`views[RouteFileKey]\` resolves
+ * to the actual component loader.
+ */
+export type RouteFileKey = ${filePages.length > 0 ? `'${filePages.map((p) => p.name).join("' | '")}'` : "never"};
+
+/**
+ * Route keys declared via \`.reuse.ts\` / \`.reuse.vue\`.
+ * They reference another route's component via \`reuseTarget\`.
+ */
+export type RouteReuseKey = ${reusePages.length > 0 ? `'${reusePages.map((p) => p.name).join("' | '")}'` : "never"};
+
+/**
+ * Builtin route keys (framework-provided, e.g. \`root\` / \`not_found\`).
+ * Currently unused — reserved for future builtin pages.
+ */
+export type BuiltinRouteKey = never;
+
+/**
+ * All page route names. Union of {@link RouteFileKey}, {@link RouteReuseKey}
+ * and {@link BuiltinRouteKey}.
+ */
+export type RouteKey = ${scanResult.pages.length > 0 ? `'${scanResult.pages.map((p) => p.name).join("' | '")}'` : "never"};
 
 export type Lazy<T> = () => Promise<T>;
 export type RawRouteComponent = import('vue').Component | Lazy<import('vue').Component>;
@@ -95,7 +125,14 @@ export type RawRouteComponent = import('vue').Component | Lazy<import('vue').Com
 export interface RouteRecord {
   name: RouteKey;
   path: string;
-  component: string;
+  /**
+   * Key into the \`views\` map — resolve the actual component via
+   * \`views[route.component]\`.
+   *
+   * For reuse routes, this is the \`reuseTarget\`'s \`RouteFileKey\`
+   * (not the reuse route's own name), so the same component is reused.
+   */
+  component: RouteFileKey;
   layout?: LayoutKey | false;
   reuse?: boolean;
   meta?: Record<string, unknown>;
@@ -108,19 +145,19 @@ export const layouts: Record<LayoutKey, RawRouteComponent> = {
 ${layouts}
 };
 
-export const views: Record<RouteKey, RawRouteComponent> = {
+export const views: Record<RouteFileKey, RawRouteComponent> = {
 ${views}
 };
 `;
 	}
 	renderLayoutImport(layout) {
-		const importPath = this.opts.getLayoutImportPath?.(layout) ?? defaultLayoutImportPath(layout, this.opts.cwd);
+		const importPath = this.opts.getLayoutImportPath?.(layout) ?? defaultLayoutImportPath(layout, this.opts.srcDir);
 		if (typeof this.opts.layoutLazy === "function" ? this.opts.layoutLazy(layout) : this.opts.layoutLazy) return `  ${layout.name}: () => import(${JSON.stringify(importPath)})`;
 		const importName = `__layout_${layout.name}`;
 		return `  ${layout.name}: ${importName}, // import ${importName} from ${JSON.stringify(importPath)}`;
 	}
 	renderViewImport(page) {
-		const importPath = this.opts.getImportPath?.(page) ?? defaultPageImportPath(page, this.opts.cwd);
+		const importPath = this.opts.getImportPath?.(page) ?? defaultPageImportPath(page, this.opts.srcDir);
 		if (typeof this.opts.routeLazy === "function" ? this.opts.routeLazy(page) : this.opts.routeLazy) return `  ${page.name}: () => import(${JSON.stringify(importPath)})`;
 		return `  ${page.name}: ${page.name}, // import ${page.name} from ${JSON.stringify(importPath)}`;
 	}
@@ -158,6 +195,20 @@ ${pathMapEntries}
    * Reuse route keys (pages using \`.reuse.vue\` suffix).
    */
   export type ReuseRouteKey = ${reuseKeys};
+
+  /**
+   * Builtin route keys (framework-provided, e.g. \`root\` / \`not_found\`).
+   * Currently unused — reserved for future builtin pages.
+   */
+  export type BuiltinRouteKey = never;
+
+  /**
+   * Route keys that have a corresponding source file (\`.vue\` / \`.md\`).
+   * Excludes reuse routes and builtin routes.
+   *
+   * Use this to index the \`views\` map for component lookup.
+   */
+  export type RouteFileKey = Exclude<RouteKey, ReuseRouteKey | BuiltinRouteKey>;
 }
 
 declare module 'vue-router/auto-routes' {
@@ -184,7 +235,7 @@ declare module 'vue-router' {
   }
 }
 
-export type { RouteLayoutKey, RoutePathMap, RouteKey, RoutePath, ReuseRouteKey } from '@ubean/routing';
+export type { RouteLayoutKey, RoutePathMap, RouteKey, RoutePath, ReuseRouteKey, BuiltinRouteKey, RouteFileKey } from '@ubean/routing';
 `;
 	}
 	/**
@@ -205,11 +256,31 @@ export type { RouteLayoutKey, RoutePathMap, RouteKey, RoutePath, ReuseRouteKey }
 		return `RouteRecordInfo<${JSON.stringify(page.name)}, ${JSON.stringify(page.route)}, ${paramsRaw}, ${paramsResolved}>`;
 	}
 };
-function defaultPageImportPath(page, cwd) {
-	return `@/${relativePosix(cwd, page.fullPath).replace(/\.(vue|tsx?|jsx?|mdx?)$/, "")}`;
+/**
+* Extensions stripped when computing the default import specifier.
+*
+* `.vue` / `.md` / `.mdx` are KEPT — Vite dispatches them to dedicated
+* transforms (vue-loader / markdown) based on the extension, so the
+* explicit suffix is required for correct resolution at runtime.
+*
+* `.ts` / `.tsx` / `.js` / `.jsx` are STRIPPED — TypeScript/Vite convention
+* is to import script modules without their extension.
+*/
+const STRIPPABLE_IMPORT_EXT = /\.(tsx?|jsx?)$/;
+/**
+* Compute the default import specifier for a page.
+*
+* Uses `srcDir` (not `cwd`) as the relative base so that the resulting
+* `@/<rel>` path matches the common `@/` → `src/` path alias. For example,
+* a page at `<cwd>/src/pages/about.vue` becomes `@/pages/about.vue`
+* (NOT `@/src/pages/about.vue`, which would double the `src/` prefix and
+* fail to resolve under the standard alias).
+*/
+function defaultPageImportPath(page, srcDir) {
+	return `@/${relativePosix(srcDir, page.fullPath).replace(STRIPPABLE_IMPORT_EXT, "")}`;
 }
-function defaultLayoutImportPath(layout, cwd) {
-	return `@/${relativePosix(cwd, layout.fullPath).replace(/\.(vue|tsx?|jsx?)$/, "")}`;
+function defaultLayoutImportPath(layout, srcDir) {
+	return `@/${relativePosix(srcDir, layout.fullPath).replace(STRIPPABLE_IMPORT_EXT, "")}`;
 }
 /**
 * 从 vue-router 风格路径中提取参数信息。

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ubean/routing",
-  "version": "0.1.7",
+  "version": "0.1.8",
   "description": "File-based routing core for ubean (scanner, rou3 matcher, route name generator, define-page AST extractor, file generator)",
   "files": [
     "dist"
@@ -30,20 +30,20 @@
     "scule": "^1.3.0",
     "tinyglobby": "^0.2.17",
     "ufo": "1.6.4",
-    "@ubean/types": "0.1.7",
-    "@ubean/utils": "0.1.7"
+    "@ubean/types": "0.1.8",
+    "@ubean/utils": "0.1.8"
   },
   "devDependencies": {
-    "@types/node": "^26.1.1",
-    "typescript": "6.0.3",
+    "@types/node": "^26.1.2",
+    "typescript": "7.0.2",
     "vite-plus": "0.2.6",
     "vue": "^3.5.40",
     "vue-router": "^5.2.0",
-    "@ubean/markdown": "0.1.7"
+    "@ubean/markdown": "0.1.8"
   },
   "peerDependencies": {
     "vue-router": "^4.0.0",
-    "@ubean/markdown": "0.1.7"
+    "@ubean/markdown": "0.1.8"
   },
   "peerDependenciesMeta": {
     "@ubean/markdown": {