feat(projects): add getRoutePath transform

examples/template-vue/src/router/elegant/transform.ts

@@ -5,6 +5,7 @@
 
 import type { RouteRecordRaw, RouteComponent } from 'vue-router';
 import type { ElegantConstRoute } from '@elegant-router/vue';
+import type { RouteKey, RouteMap } from '@elegant-router/types';
 
 /**
  * transform elegant const routes to vue routes
@@ -129,5 +130,28 @@ function transformElegantRouteToVueRoute(
   vueRoutes.unshift(vueRoute);
 
   return vueRoutes;
-}  
+}
+
+export function getRoutePath(key: RouteKey) {
+  const routeMap: RouteMap = {
+    "root": "/",
+    "not-found": "/:pathMatch(.*)*",
+    "403": "/403",
+    "404": "/404",
+    "500": "/500",
+    "about": "/about",
+    "list": "/list",
+    "list_detail": "/list/detail",
+    "list_home": "/list/home",
+    "multi-menu": "/multi-menu",
+    "multi-menu_first": "/multi-menu/first",
+    "multi-menu_first_child": "/multi-menu/first/child",
+    "multi-menu_second": "/multi-menu/second",
+    "multi-menu_second_child": "/multi-menu/second/child",
+    "multi-menu_second_child_home": "/multi-menu/second/child/home",
+    "user": "/user/:id"
+  };
+
+  return routeMap[key];
+}
 

packages/vue/src/core/dts.ts

@@ -1,10 +1,11 @@
 import path from 'node:path';
 import { writeFile } from 'node:fs/promises';
-import { PAGE_DEGREE_SPLITTER, splitRouterName, transformRouterNameToPath } from '@elegant-router/core';
+import { PAGE_DEGREE_SPLITTER } from '@elegant-router/core';
 import type { ElegantRouterFile, ElegantRouterNamePathEntry } from '@elegant-router/core';
-import { ensureFile } from '../shared/fs';
-import type { ElegantVueRouterOption } from '../types';
 import { createPrefixCommentOfGenFile } from './comment';
+import { getCustomRouteConfig } from './shared';
+import { ensureFile } from '../shared/fs';
+import type { ElegantVueRouterOption, CustomRouteConfig } from '../types';
 import { LAYOUT_PREFIX, VIEW_PREFIX } from '../constants';
 
 export async function genDtsFile(
@@ -27,58 +28,6 @@ export async function genDtsFile(
   await writeFile(dtsPath, code);
 }
 
-type CustomRouteConfig = {
-  entries: ElegantRouterNamePathEntry[];
-  firstLevelRoutes: string[];
-  lastLevelRoutes: string[];
-};
-
-/**
- * get custom route config
- * @param options
- */
-function getCustomRouteConfig(options: ElegantVueRouterOption): CustomRouteConfig {
-  const { map, names } = options.customRoutes;
-
-  const entries: ElegantRouterNamePathEntry[] = [];
-
-  const firstLevelRoutes: string[] = [];
-  const lastLevelRoutes: string[] = [];
-
-  Object.entries(map).forEach(([name, rPath]) => {
-    const routeName = options.routeNameTransformer(name.toLocaleLowerCase());
-    const routePath = options.routePathTransformer(routeName, rPath);
-
-    entries.push([routeName, routePath]);
-    firstLevelRoutes.push(routeName);
-    lastLevelRoutes.push(routeName);
-  });
-
-  names.forEach(name => {
-    const itemNames = splitRouterName(name);
-    itemNames.forEach((itemName, index) => {
-      const transformName = itemName.toLocaleLowerCase();
-      const routeName = options.routeNameTransformer(transformName);
-      const routePath = options.routePathTransformer(routeName, transformRouterNameToPath(transformName));
-
-      entries.push([routeName, routePath]);
-      if (index === 0) {
-        firstLevelRoutes.push(routeName);
-      }
-
-      if (index === itemNames.length - 1) {
-        lastLevelRoutes.push(routeName);
-      }
-    });
-  });
-
-  return {
-    entries,
-    firstLevelRoutes,
-    lastLevelRoutes
-  };
-}
-
 function getDtsCode(
   files: ElegantRouterFile[],
   entries: ElegantRouterNamePathEntry[],

packages/vue/src/core/index.ts

@@ -20,7 +20,7 @@ export default class ElegantVueRouter {
 
     this.options = createPluginOptions(this.elegantRouter.options, options);
 
-    genTransformFile(this.options);
+    genTransformFile(this.options, this.elegantRouter.entries);
 
     this.generate();
   }

packages/vue/src/core/shared.ts

@@ -0,0 +1,49 @@
+import { splitRouterName, transformRouterNameToPath } from '@elegant-router/core';
+import type { ElegantRouterNamePathEntry } from '@elegant-router/core';
+import type { ElegantVueRouterOption, CustomRouteConfig } from '../types';
+
+/**
+ * get custom route config
+ * @param options
+ */
+export function getCustomRouteConfig(options: ElegantVueRouterOption): CustomRouteConfig {
+  const { map, names } = options.customRoutes;
+
+  const entries: ElegantRouterNamePathEntry[] = [];
+
+  const firstLevelRoutes: string[] = [];
+  const lastLevelRoutes: string[] = [];
+
+  Object.entries(map).forEach(([name, rPath]) => {
+    const routeName = options.routeNameTransformer(name.toLocaleLowerCase());
+    const routePath = options.routePathTransformer(routeName, rPath);
+
+    entries.push([routeName, routePath]);
+    firstLevelRoutes.push(routeName);
+    lastLevelRoutes.push(routeName);
+  });
+
+  names.forEach(name => {
+    const itemNames = splitRouterName(name);
+    itemNames.forEach((itemName, index) => {
+      const transformName = itemName.toLocaleLowerCase();
+      const routeName = options.routeNameTransformer(transformName);
+      const routePath = options.routePathTransformer(routeName, transformRouterNameToPath(transformName));
+
+      entries.push([routeName, routePath]);
+      if (index === 0) {
+        firstLevelRoutes.push(routeName);
+      }
+
+      if (index === itemNames.length - 1) {
+        lastLevelRoutes.push(routeName);
+      }
+    });
+  });
+
+  return {
+    entries,
+    firstLevelRoutes,
+    lastLevelRoutes
+  };
+}

packages/vue/src/core/transform.ts

@@ -1,15 +1,17 @@
 import path from 'node:path';
 import { writeFile } from 'node:fs/promises';
+import type { ElegantRouterNamePathEntry } from '@elegant-router/core';
 import { createPrefixCommentOfGenFile } from './comment';
+import { getCustomRouteConfig } from './shared';
 import { ensureFile } from '../shared/fs';
 import type { ElegantVueRouterOption } from '../types';
 
 /**
  * generate the transform file
  * @param options
  */
-export async function genTransformFile(options: ElegantVueRouterOption) {
-  const code = getTransformCode();
+export async function genTransformFile(options: ElegantVueRouterOption, entries: ElegantRouterNamePathEntry[]) {
+  const code = getTransformCode(options, entries);
 
   const transformPath = path.posix.join(options.cwd, options.transformDir);
 
@@ -18,13 +20,18 @@ export async function genTransformFile(options: ElegantVueRouterOption) {
   await writeFile(transformPath, code);
 }
 
-function getTransformCode() {
+function getTransformCode(options: ElegantVueRouterOption, entries: ElegantRouterNamePathEntry[]) {
   const prefixComment = createPrefixCommentOfGenFile();
 
+  const { entries: customEntries } = getCustomRouteConfig(options);
+
+  const allEntries = [...customEntries, ...entries];
+
   const code = `${prefixComment}
 
 import type { RouteRecordRaw, RouteComponent } from 'vue-router';
 import type { ElegantConstRoute } from '@elegant-router/vue';
+import type { RouteKey, RouteMap } from '@elegant-router/types';
 
 /**
  * transform elegant const routes to vue routes
@@ -149,8 +156,19 @@ function transformElegantRouteToVueRoute(
   vueRoutes.unshift(vueRoute);
 
   return vueRoutes;
-}  
+}
 
+/**
+ * get route path by route key
+ * @param key route key
+ */
+export function getRoutePath(key: RouteKey) {
+  const routeMap: RouteMap = {
+    ${allEntries.map(([routeName, routePath]) => `"${routeName}": "${routePath}"`).join(',\n    ')}
+  };
+
+  return routeMap[key];
+}
 `;
 
   return code;

packages/vue/src/types/index.ts

@@ -1,5 +1,5 @@
 import type { _RouteRecordBase } from 'vue-router';
-import type { ElegantRouterOption } from '@elegant-router/core';
+import type { ElegantRouterOption, ElegantRouterNamePathEntry } from '@elegant-router/core';
 
 export interface ElegantVueRouterOption extends ElegantRouterOption {
   /**
@@ -106,6 +106,15 @@ export interface ElegantVueRouterOption extends ElegantRouterOption {
   onRouteMetaGen(routeName: string): Record<string, unknown>;
 }
 
+/**
+ *
+ */
+export type CustomRouteConfig = {
+  entries: ElegantRouterNamePathEntry[];
+  firstLevelRoutes: string[];
+  lastLevelRoutes: string[];
+};
+
 /**
  * elegant const route
  */