vite-plugin-generoutes 0.2.7 → 0.2.9

package/LICENSE

@@ -0,0 +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.

package/dist/index.d.ts

@@ -10,30 +10,35 @@ 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
      */
     nested: boolean;
 }
-declare function VitePluginGeneroutes(options?: Partial<Options>): Plugin<any>;
+declare function VitePluginGeneroutes(options?: Partial<Options>): Plugin;
 
 export { VitePluginGeneroutes as default };

package/dist/index.js

@@ -59,19 +59,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}/**`) });
@@ -90,7 +85,7 @@ function VitePluginGeneroutes(options = {}) {
         name,
         path: routePath,
         redirect: defineOptions.redirect,
-        component,
+        component: defineOptions.redirect ? void 0 : component,
         meta,
         parent: defineOptions.parent
       };
@@ -107,8 +102,7 @@ function VitePluginGeneroutes(options = {}) {
   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!!!
+    // Generated by vite-plugin-generoutes, don't modify it directly.
 
     export const routes = ${JSON.stringify(routes, null, 2)}
     `;
@@ -139,7 +133,8 @@ function VitePluginGeneroutes(options = {}) {
     async configResolved(config) {
       rootDir = config.root;
       await writerRoutesFile();
-      config.command !== "build" && createWatcher();
+      if (config.command !== "build")
+        createWatcher();
     },
     async handleHotUpdate({ file, read }) {
       if (file.includes(pagesFolder) && !ignoreFolders.some((folder) => file.includes(`/${folder}/`)) && file.endsWith(".vue")) {
@@ -151,7 +146,8 @@ function VitePluginGeneroutes(options = {}) {
       }
     },
     closeBundle() {
-      watcher && watcher.close();
+      if (watcher)
+        watcher.close();
     }
   };
 }

package/package.json

@@ -1,81 +1,83 @@
-{
-  "name": "vite-plugin-generoutes",
-  "type": "module",
-  "version": "0.2.7",
-  "packageManager": "pnpm@9.1.1",
-  "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",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/zclzone/vite-plugin-generoutes.git"
-  },
-  "bugs": "https://github.com/zclzone/vite-plugin-generoutes/issues",
-  "keywords": [],
-  "sideEffects": false,
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js"
-    }
-  },
-  "main": "./dist/index.js",
-  "module": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "typesVersions": {
-    "*": {
-      "*": [
-        "./dist/*",
-        "./dist/index.d.ts"
-      ]
-    }
-  },
-  "files": [
-    "dist"
-  ],
-  "scripts": {
-    "start": "tsup --watch",
-    "build": "tsup",
-    "lint": "eslint .",
-    "prepublishOnly": "nr build",
-    "release": "bumpp && npm publish",
-    "test": "vitest",
-    "typecheck": "tsc --noEmit",
-    "prepare": "simple-git-hooks"
-  },
-  "peerDependencies": {
-    "vite": "^5.2.11"
-  },
-  "dependencies": {
-    "@antfu/utils": "^0.7.8",
-    "@vue/compiler-sfc": "^3.4.27",
-    "chokidar": "^3.6.0",
-    "fs-extra": "^11.2.0",
-    "glob": "^10.4.1",
-    "prettier": "^3.3.2"
-  },
-  "devDependencies": {
-    "@antfu/eslint-config": "^2.18.1",
-    "@antfu/ni": "^0.21.12",
-    "@types/fs-extra": "^11.0.4",
-    "@types/node": "^20.12.12",
-    "bumpp": "^9.4.1",
-    "eslint": "^9.3.0",
-    "esno": "^4.7.0",
-    "lint-staged": "^15.2.2",
-    "pnpm": "^9.1.1",
-    "rimraf": "^5.0.7",
-    "simple-git-hooks": "^2.11.1",
-    "tsup": "^8.1.0",
-    "typescript": "^5.4.5",
-    "unbuild": "^2.0.0",
-    "vitest": "^1.6.0"
-  },
-  "simple-git-hooks": {
-    "pre-commit": "pnpm lint-staged"
-  },
-  "lint-staged": {
-    "*": "eslint --fix"
-  }
-}
+{
+  "name": "vite-plugin-generoutes",
+  "type": "module",
+  "version": "0.2.9",
+  "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>",
+  "license": "MIT",
+  "homepage": "https://github.com/zclzone/vite-plugin-generoutes",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/zclzone/vite-plugin-generoutes.git"
+  },
+  "bugs": "https://github.com/zclzone/vite-plugin-generoutes/issues",
+  "keywords": [],
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "*": [
+        "./dist/*",
+        "./dist/index.d.ts"
+      ]
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "start": "tsup --watch",
+    "build": "tsup",
+    "lint": "eslint .",
+    "prepublishOnly": "nr build",
+    "release": "bumpp && npm publish",
+    "test": "vitest",
+    "typecheck": "tsc --noEmit",
+    "prepare": "simple-git-hooks",
+    "up:deps": "taze major -I"
+  },
+  "peerDependencies": {
+    "vite": "^5.2.11"
+  },
+  "dependencies": {
+    "@antfu/utils": "^0.7.10",
+    "@vue/compiler-sfc": "^3.4.38",
+    "chokidar": "^3.6.0",
+    "fs-extra": "^11.2.0",
+    "glob": "^10.4.5",
+    "prettier": "^3.3.3"
+  },
+  "devDependencies": {
+    "@antfu/eslint-config": "^3.0.0",
+    "@antfu/ni": "^0.23.0",
+    "@types/fs-extra": "^11.0.4",
+    "@types/node": "^20.16.2",
+    "bumpp": "^9.5.2",
+    "eslint": "^9.9.1",
+    "esno": "^4.7.0",
+    "lint-staged": "^15.2.9",
+    "pnpm": "^9.9.0",
+    "rimraf": "^5.0.10",
+    "simple-git-hooks": "^2.11.1",
+    "taze": "^0.16.7",
+    "tsup": "^8.2.4",
+    "typescript": "^5.5.4",
+    "unbuild": "^2.0.0",
+    "vitest": "^2.0.5"
+  },
+  "simple-git-hooks": {
+    "pre-commit": "pnpm lint-staged"
+  },
+  "lint-staged": {
+    "*": "eslint --fix"
+  }
+}