vite-plugin-generoutes 0.2.4 → 0.2.6

package/README.md

@@ -1,6 +1,6 @@
 # vite-plugin-generoutes
 
-A Vite plugin that generates routes based on the file structure, supports dynamic routes, and supports custom meta data for each route.
+A Vite plugin that generate routes based on the file structure, supports dynamic routes, and supports custom meta data for each route.
 
 ## Usage
 
@@ -39,68 +39,44 @@ src/routes/pages
     └── [...all].vue
 ```
 
-The above example will generate the routes file `src/router/generoutes/index.js` with the following content:
+The above example will generate the routes file `src/pages/generoutes.js` with the following content:
 ```js
 export const routes = [
   {
     name: 'Index',
     path: '/',
     component: () => import('/src/pages/index.vue'),
-    meta: {
-      title: 'Index',
-      show: true,
-      keepAlive: false,
-    },
+    meta: {},
   },
   {
     name: 'User',
     path: '/user',
     component: () => import('/src/pages/user/index.vue'),
-    meta: {
-      title: 'User',
-      show: true,
-      keepAlive: false,
-    },
+    meta: {},
   },
   {
     name: 'User_[id]',
     path: '/user/:id',
     component: () => import('/src/pages/user/[id]/index.vue'),
-    meta: {
-      title: 'User_[id]',
-      show: true,
-      keepAlive: false,
-    },
+    meta: {},
   },
   {
     name: 'User_Post',
     path: '/user/post',
     component: () => import('/src/pages/user/post/index.vue'),
-    meta: {
-      title: 'User_Post',
-      show: true,
-      keepAlive: false,
-    },
+    meta: {},
   },
   {
     name: 'Index_[...all]',
     path: '/:pathMatch(.*)*',
     component: () => import('/src/pages/[...all].vue'),
-    meta: {
-      title: '404 Not Found',
-      show: true,
-      keepAlive: false,
-    },
+    meta: {},
   },
   {
     name: 'User_Post_[...all]',
     path: '/user/post/:pathMatch(.*)*',
     component: () => import('/src/pages/user/post/[...all].vue'),
-    meta: {
-      title: 'User_Post_[...all]',
-      show: true,
-      keepAlive: false,
-    },
+    meta: {},
   },
 ]
 ```
@@ -109,7 +85,7 @@ export const routes = [
 
 ```js
 import { createRouter, createWebHashHistory } from 'vue-router'
-import { routes } from './generoutes'
+import { routes } from './pages/generoutes'
 
 const router = createRouter({
   history: createWebHashHistory(),
@@ -127,9 +103,10 @@ export default router
 - Support custom meta data for each route.
 - Support ghost paths, For example, the (admin) folder will not be part of the route path, which is very useful for folder grouping.
 - Support immediate update of the routes file when the file structure or defineOptions changes.
+- Support nested route.
 
 ## Custom route info，including name and meta
 
 You can define `name` and `meta` fields in the `defineOptions` of your `.vue` file, which will be used to override the default properties of the generated route. The `name` field will be used as the route name, which is very useful for `KeepAlive`. Any property in `defineOptions.meta` will be used as a property of the route `meta`, which makes the route metadata very flexible.
 
-When you make any changes that may affect the route result, the `src/router/generoutes/index.js` file will be updated immediately, and the page will be refreshed without restarting the server.
+When you make any changes that may affect the route result, the `src/pages/generoutes.js` file will be updated immediately, and the page will be refreshed without restarting the server.

package/dist/index.d.ts

@@ -3,7 +3,7 @@ import { Plugin } from 'vite';
 /**********************************
  * @Author: Ronnie Zhang
  * @LastEditor: Ronnie Zhang
- * @LastEditTime: 2023/12/04 22:48:11
+ * @LastEditTime: 2024/07/01 14:51:47
  * @Email: zclzone@outlook.com
  * Copyright © 2023 Ronnie Zhang(大脸怪) | https://isme.top
  **********************************/

package/dist/index.js

@@ -79,19 +79,20 @@ function VitePluginGeneroutes(options = {}) {
       filePath = slash(filePath);
       const defineOptions = parseDefineOptions(filePath) || {};
       defineOptionsCache.set(filePath, JSON.stringify(defineOptions));
-      const meta = defineOptions?.meta || {};
+      const meta = defineOptions.meta || {};
       if (meta.enabled === false)
         return null;
       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 name = defineOptions.name || pathSegments.map((item) => toPascalCase(item)).join("_") || "Index";
       const component = `##/${filePath}##`;
       const routePath = `/${pathSegments.map((item) => item.replace(/\[(.*?)\]/g, (_, p1) => p1 === "...all" ? ":pathMatch(.*)*" : p1.split(",").map((i) => `:${i}`).join("/"))).join("/")}`;
       return {
         name,
         path: routePath,
+        redirect: defineOptions.redirect,
         component,
         meta,
-        parent: defineOptions?.parent
+        parent: defineOptions.parent
       };
     }).filter(Boolean);
     const { duplicateNames, duplicatePaths } = findDuplicateRoutes(routes);
@@ -118,15 +119,18 @@ function VitePluginGeneroutes(options = {}) {
     fs.writeFileSync(filePath, routesStr);
   }
   const debounceWriter = debounce(500, writerRoutesFile);
+  let watcher;
   function createWatcher() {
-    const watcher = chokidar.watch(`${pagesFolder}/**/*.vue`, { ignoreInitial: true });
+    watcher = chokidar.watch(`${pagesFolder}/**/*.vue`, { ignoreInitial: true });
     return watcher.on("all", async (event, path2) => {
       if (ignoreFolders.some((folder) => slash(path2).includes(`/${folder}/`)))
         return;
       if (path2.endsWith(".vue") && (event === "add" || event === "unlink")) {
         debounceWriter();
-        await watcher.close();
-        createWatcher();
+        if (watcher) {
+          await watcher.close();
+          createWatcher();
+        }
       }
     });
   }
@@ -145,6 +149,9 @@ function VitePluginGeneroutes(options = {}) {
           debounceWriter();
         }
       }
+    },
+    closeBundle() {
+      watcher && watcher.close();
     }
   };
 }

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "vite-plugin-generoutes",
   "type": "module",
-  "version": "0.2.4",
+  "version": "0.2.6",
   "packageManager": "pnpm@9.1.1",
-  "description": "_description_",
+  "description": "A Vite plugin that generate routes based on the file structure, supports dynamic routes, and supports custom meta data for each route.",
   "author": "Ronnie Zhang <zclzone@outlook.com>",
   "license": "MIT",
   "homepage": "https://github.com/zclzone/vite-plugin-generoutes",