vite-plugin-generoutes 0.2.0 → 0.2.3

package/dist/index.d.ts

@@ -10,13 +10,29 @@ import { Plugin } from 'vite';
 
 interface Options {
     /**
-     * default: `src/router/pages`
+     * pages 文件夹
+     *
+     * default: `src/pages`
      */
     pagesFolder: string;
     /**
-     * default: `src/router/generoutes.js`
+     * 忽略文件夹
+     *
+     * default: `['components']`
+     */
+    ignoreFolders: string[];
+    /**
+     * 路由文件路径
+     *
+     * default: `${pagesFolder}/generoutes.js`
      */
     routesPath?: string;
+    /**
+     * 是否嵌套
+     *
+     * default: false
+     */
+    nested: boolean;
 }
 declare function VitePluginGeneroutes(options?: Partial<Options>): Plugin<any>;
 

package/dist/index.js

@@ -6,52 +6,86 @@ import { parse } from "@vue/compiler-sfc";
 import { debounce, slash } from "@antfu/utils";
 import chokidar from "chokidar";
 import prettier from "prettier";
+
+// src/utils.ts
 function toPascalCase(str) {
   return str.toLowerCase().replace(/(?:^|-)([a-z])/g, (_, p1) => {
     return p1.toUpperCase();
   });
 }
+function convertToTree(routes) {
+  const nodeMap = {};
+  const result = [];
+  routes.forEach((route) => {
+    const { parent, ...node } = route;
+    nodeMap[node.name] = node;
+  });
+  routes.forEach((route) => {
+    if (route.parent) {
+      const parentNode = nodeMap[route.parent];
+      if (parentNode) {
+        if (!parentNode.children) {
+          parentNode.children = [];
+        }
+        parentNode.children.push(nodeMap[route.name]);
+      }
+    } else {
+      result.push(nodeMap[route.name]);
+    }
+  });
+  return result;
+}
+function findDuplicateRoutes(routes) {
+  const nameSet = /* @__PURE__ */ new Set();
+  const pathSet = /* @__PURE__ */ new Set();
+  const duplicateNames = [];
+  const duplicatePaths = [];
+  for (const route of routes) {
+    if (nameSet.has(route.name)) {
+      duplicateNames.push(route.name);
+    } else {
+      nameSet.add(route.name);
+    }
+    if (pathSet.has(route.path)) {
+      duplicatePaths.push(route.path);
+    } else {
+      pathSet.add(route.path);
+    }
+  }
+  return {
+    duplicateNames,
+    duplicatePaths
+  };
+}
+
+// src/index.ts
 var defaultOptions = {
-  pagesFolder: "src/pages"
+  pagesFolder: "src/pages",
+  ignoreFolders: ["components"],
+  nested: false
 };
 function VitePluginGeneroutes(options = {}) {
   if (options.routesPath && ![".ts", ".js"].includes(path.extname(options.routesPath)))
     throw new Error("routesPath must be a js or ts file path, such as src/router/generoutes.js");
-  const defineOptionsCache = /* @__PURE__ */ new Map();
   let rootDir;
   const pagesFolder = options.pagesFolder || defaultOptions.pagesFolder;
-  const routesPath = options.routesPath || path.resolve(pagesFolder, "generoutes.js");
-  async function writerRoutesFile() {
-    const { routes } = generateMenusAndRoutes();
-    let routesStr = `
-    // ! \u6B64\u6587\u4EF6\u7531 vite-plugin-generoutes \u81EA\u52A8\u751F\u6210\uFF0C\u5EFA\u8BAE\u6DFB\u52A0\u5230 .gitignore\uFF0C\u8BF7\u52FF\u76F4\u63A5\u5728\u6B64\u6587\u4EF6\u4FEE\u6539!!!
-    // ! This file is generated by vite-plugin-generoutes, it is recommended to add it to .gitignore, do not modify it directly in this file!!!
-
-    export const routes = ${JSON.stringify(routes, null, 2)}
-    `;
-    routesStr = routesStr.replace(/"##(.*)##"/g, (_, p1) => `() => import('${p1}')`);
-    routesStr = await prettier.format(routesStr, { parser: "babel", semi: false, singleQuote: true });
-    fs.writeFileSync(`${path.resolve(rootDir, routesPath)}`, routesStr);
-  }
-  const debounceWriter = debounce(500, writerRoutesFile);
+  const routesPath = options.routesPath || path.join(pagesFolder, "generoutes.js");
+  const nested = options.nested || defaultOptions.nested;
+  const ignoreFolders = options.ignoreFolders || defaultOptions.ignoreFolders;
+  const defineOptionsCache = /* @__PURE__ */ new Map();
   function generateMenusAndRoutes() {
-    const pages = globSync(`${pagesFolder}/**/index.vue`).concat(globSync(`${pagesFolder}/**/\\[...all\\].vue`));
+    const pages = globSync(`${pagesFolder}/**/*.vue`, { ignore: ignoreFolders.map((folder) => `${pagesFolder}/**/${folder}/**`) });
     const routes = pages.map((filePath) => {
       filePath = slash(filePath);
-      const defineOptions = parseDefineOptions(filePath);
+      const defineOptions = parseDefineOptions(filePath) || {};
       defineOptionsCache.set(filePath, JSON.stringify(defineOptions));
       const meta = defineOptions?.meta || {};
       if (meta.enabled === false)
         return null;
-      const fileName = path.basename(filePath);
-      const pathSegments = path.dirname(filePath).replace(`${pagesFolder}`, "").split("/").filter((item) => !!item && !/^\(.*\)$/.test(item));
-      let name = defineOptions?.name || pathSegments.map((item) => toPascalCase(item)).join("_") || "Index";
+      const pathSegments = filePath.replace(`${pagesFolder}`, "").replace(".vue", "").replace("index", "").split("/").filter((item) => !!item && !/^\(.*\)$/.test(item));
+      const name = defineOptions?.name || pathSegments.map((item) => toPascalCase(item)).join("_") || "Index";
       const component = `##/${filePath}##`;
-      let routePath = `/${pathSegments.map((item) => item.replace(/\[(.*?)\]/g, (_, p1) => p1.split(",").map((i) => `:${i}`).join("/"))).join("/")}`;
-      if (fileName === "[...all].vue") {
-        name = `${name}_[...all]`;
-        routePath = routePath === "/" ? "/:pathMatch(.*)*" : `${routePath}/:pathMatch(.*)*`;
-      }
+      const routePath = `/${pathSegments.map((item) => item.replace(/\[(.*?)\]/g, (_, p1) => p1 === "...all" ? ":pathMatch(.*)*" : p1.split(",").map((i) => `:${i}`).join("/"))).join("/")}`;
       if (!("title" in meta))
         meta.title = name;
       if (!("show" in meta))
@@ -61,17 +95,40 @@ function VitePluginGeneroutes(options = {}) {
         name,
         path: routePath,
         component,
-        meta
+        meta,
+        parent: defineOptions?.parent
       };
     }).filter(Boolean);
+    const { duplicateNames, duplicatePaths } = findDuplicateRoutes(routes);
+    if (duplicateNames.length)
+      console.warn(`Warning: Duplicate names found in routes: ${duplicateNames.join(", ")}`);
+    if (duplicatePaths.length)
+      console.warn(`Warning: Duplicate paths found in routes: ${duplicatePaths.join(", ")}`);
     return {
-      routes
+      routes: nested ? convertToTree(routes) : routes
     };
   }
+  async function writerRoutesFile() {
+    const { routes } = generateMenusAndRoutes();
+    let routesStr = `
+    // ! \u6B64\u6587\u4EF6\u7531 vite-plugin-generoutes \u81EA\u52A8\u751F\u6210\uFF0C\u5EFA\u8BAE\u6DFB\u52A0\u5230 .gitignore\uFF0C\u8BF7\u52FF\u76F4\u63A5\u5728\u6B64\u6587\u4EF6\u4FEE\u6539!!!
+    // ! This file is generated by vite-plugin-generoutes, it is recommended to add it to .gitignore, do not modify it directly in this file!!!
+
+    export const routes = ${JSON.stringify(routes, null, 2)}
+    `;
+    routesStr = routesStr.replace(/"##(.*)##"/g, (_, p1) => `() => import('${p1}')`);
+    routesStr = await prettier.format(routesStr, { parser: "babel", semi: false, singleQuote: true });
+    const filePath = path.resolve(rootDir, routesPath);
+    await fs.ensureDir(path.dirname(filePath));
+    fs.writeFileSync(filePath, routesStr);
+  }
+  const debounceWriter = debounce(500, writerRoutesFile);
   function createWatcher() {
-    const watcher = chokidar.watch([`${pagesFolder}/**/index.vue`, `${pagesFolder}/**/[...all].vue`], { ignoreInitial: true });
+    const watcher = chokidar.watch(`${pagesFolder}/**/*.vue`, { ignoreInitial: true });
     return watcher.on("all", async (event, path2) => {
-      if ((path2.endsWith("index.vue") || path2.endsWith("[...all].vue")) && (event === "add" || event === "unlink")) {
+      if (ignoreFolders.some((folder) => slash(path2).includes(`/${folder}/`)))
+        return;
+      if (path2.endsWith(".vue") && (event === "add" || event === "unlink")) {
         debounceWriter();
         await watcher.close();
         createWatcher();
@@ -82,20 +139,15 @@ function VitePluginGeneroutes(options = {}) {
     name: "vite-plugin-generoutes",
     async configResolved(config) {
       rootDir = config.root;
-      await fs.ensureDir(path.dirname(routesPath));
       await writerRoutesFile();
       config.command !== "build" && createWatcher();
     },
     async handleHotUpdate({ file, read }) {
-      if (file.includes("src/pages") && (file.endsWith("index.vue") || file.endsWith("[...all].vue"))) {
+      if (file.includes(pagesFolder) && !ignoreFolders.some((folder) => file.includes(`/${folder}/`)) && file.endsWith(".vue")) {
         const prevDefineOptions = defineOptionsCache.get(slash(path.relative(rootDir, file)));
-        if (!prevDefineOptions) {
+        const defineOptions = JSON.stringify(parseDefineOptions(file, await read()));
+        if (prevDefineOptions !== defineOptions) {
           debounceWriter();
-        } else {
-          const defineOptions = JSON.stringify(parseDefineOptions(file, await read()));
-          if (prevDefineOptions !== defineOptions) {
-            debounceWriter();
-          }
         }
       }
     }
@@ -106,16 +158,16 @@ function parseDefineOptions(filePath, content) {
   const { descriptor } = parse(content);
   const setupScript = descriptor.scriptSetup?.content;
   if (setupScript) {
-    const defineOptionsMatch = setupScript.match(/defineOptions\(([^)]+)\)/);
+    const defineOptionsMatch = setupScript.match(/defineOptions\s*\(\s*(\{[\s\S]*?\})\s*\)/);
     if (defineOptionsMatch) {
       try {
         return new Function(`return ${defineOptionsMatch[1]}`)();
       } catch (e) {
-        console.error(`Failed to parse defineOptions in ${filePath}:`, e);
+        throw new Error(`Failed to parse defineOptions in ${filePath}: ${e}`);
       }
     }
   }
-  return null;
+  return {};
 }
 var src_default = VitePluginGeneroutes;
 export {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "vite-plugin-generoutes",
   "type": "module",
-  "version": "0.2.0",
+  "version": "0.2.3",
   "packageManager": "pnpm@9.1.1",
   "description": "_description_",
   "author": "Ronnie Zhang <zclzone@outlook.com>",
@@ -78,4 +78,4 @@
   "lint-staged": {
     "*": "eslint --fix"
   }
-}
+}