vite-plugin-generoutes 0.2.8 → 0.2.10

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 Ronnie Zhang(大脸怪)
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2024 Ronnie Zhang(大脸怪)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.ts

@@ -10,25 +10,30 @@ import { Plugin } from 'vite';
 
 interface Options {
     /**
-     * pages 文件夹
+     * pages folder
      *
      * default: `src/pages`
      */
     pagesFolder: string;
     /**
-     * 忽略文件夹
+     * ignore folders
+     *
+     * ignore these folders when generating routes
      *
      * default: `['components']`
      */
     ignoreFolders: string[];
     /**
-     * 路由文件路径
+     * routes file path
+     *
+     * default: `src/router/routes.js`
+     *
+     * It can also be a ts file，such as `src/router/routes.ts`
      *
-     * default: `${pagesFolder}/generoutes.js`
      */
-    routesPath?: string;
+    routesPath: string;
     /**
-     * 是否嵌套
+     * nested routes
      *
      * default: false
      */

package/dist/index.js

@@ -6,6 +6,7 @@ import { parse } from "@vue/compiler-sfc";
 import { debounce, slash } from "@antfu/utils";
 import chokidar from "chokidar";
 import prettier from "prettier";
+import chalk from "chalk";
 
 // src/utils.ts
 function toPascalCase(str) {
@@ -59,19 +60,14 @@ function findDuplicateRoutes(routes) {
 }
 
 // src/index.ts
-var defaultOptions = {
-  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");
   let rootDir;
-  const pagesFolder = options.pagesFolder || defaultOptions.pagesFolder;
-  const routesPath = options.routesPath || path.join(pagesFolder, "generoutes.js");
-  const nested = options.nested || defaultOptions.nested;
-  const ignoreFolders = options.ignoreFolders || defaultOptions.ignoreFolders;
+  const pagesFolder = options.pagesFolder || "src/pages";
+  const routesPath = options.routesPath || "src/router/routes.js";
+  const ignoreFolders = options.ignoreFolders || ["components"];
+  const nested = options.nested || false;
   const defineOptionsCache = /* @__PURE__ */ new Map();
   function generateMenusAndRoutes() {
     const pages = globSync(`${pagesFolder}/**/*.vue`, { ignore: ignoreFolders.map((folder) => `${pagesFolder}/**/${folder}/**`) });
@@ -104,11 +100,10 @@ function VitePluginGeneroutes(options = {}) {
       routes: nested ? convertToTree(routes) : routes
     };
   }
-  async function writerRoutesFile() {
+  async function writerRoutesFile(isInit = false) {
     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!!!
+    // Generated by vite-plugin-generoutes, don't modify it directly.
 
     export const routes = ${JSON.stringify(routes, null, 2)}
     `;
@@ -117,6 +112,7 @@ function VitePluginGeneroutes(options = {}) {
     const filePath = path.resolve(rootDir, routesPath);
     await fs.ensureDir(path.dirname(filePath));
     fs.writeFileSync(filePath, routesStr);
+    console.log(`  \u2705  ${isInit ? "routes generated:" : "routes updated:"} ${chalk.cyan(routesPath)}`);
   }
   const debounceWriter = debounce(500, writerRoutesFile);
   let watcher;
@@ -138,9 +134,10 @@ function VitePluginGeneroutes(options = {}) {
     name: "vite-plugin-generoutes",
     async configResolved(config) {
       rootDir = config.root;
-      await writerRoutesFile();
-      if (config.command !== "build")
+      await writerRoutesFile(true);
+      if (config.command !== "build") {
         createWatcher();
+      }
     },
     async handleHotUpdate({ file, read }) {
       if (file.includes(pagesFolder) && !ignoreFolders.some((folder) => file.includes(`/${folder}/`)) && file.endsWith(".vue")) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "vite-plugin-generoutes",
   "type": "module",
-  "version": "0.2.8",
+  "version": "0.2.10",
   "packageManager": "pnpm@9.9.0",
   "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>",
@@ -51,6 +51,7 @@
   "dependencies": {
     "@antfu/utils": "^0.7.10",
     "@vue/compiler-sfc": "^3.4.38",
+    "chalk": "^5.3.0",
     "chokidar": "^3.6.0",
     "fs-extra": "^11.2.0",
     "glob": "^10.4.5",