npm - vite-plugin-generoutes - Versions diffs - 1.0.1 → 1.1.0-beta.3 - Mend

vite-plugin-generoutes 1.0.1 → 1.1.0-beta.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

package/LICENSE CHANGED Viewed

@@ -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/README.md CHANGED Viewed

@@ -45,12 +45,20 @@ export default defineConfig({
 ### ⚙️ Configuration Options
-| Option          | Type       | Default                  | Description                                             |
-| --------------- | ---------- | ------------------------ | ------------------------------------------------------- |
-| `pagesFolder`   | `string`   | `'src/pages'`            | Path to pages folder                                    |
-| `ignoreFolders` | `string[]` | `['components']`         | Folders to ignore when generating routes                |
-| `routesPath`    | `string`   | `'src/router/routes.js'` | Path to generated routes file, can also be a `.ts` file |
-| `nested`        | `boolean`  | `false`                  | Whether to generate nested routes                       |
+| Option          | Type       | Default          | Description                                                                                                       |
+| --------------- | ---------- | ---------------- | ----------------------------------------------------------------------------------------------------------------- |
+| `pagesFolder`   | `string`   | `'src/pages'`    | Path to pages folder                                                                                              |
+| `ignoreFolders` | `string[]` | `['components']` | Folders to ignore when generating routes                                                                          |
+| `routesPath`    | `string`   | Auto-detected    | Path to generated routes file. Auto-detected based on `tsconfig.json` presence (`.ts` if exists, otherwise `.js`) |
+| `nested`        | `boolean`  | `false`          | Whether to generate nested routes                                                                                 |
+### 📘 TypeScript Support
+This plugin has first-class TypeScript support:
+- **Auto-detection**: Automatically detects TypeScript projects by checking for `tsconfig.json`
+- **Type definitions**: When generating routes for TypeScript projects, the plugin automatically includes type definitions for `RouteMeta` and `GeneratedRoute`
+- **Route typing**: Generated routes are properly typed with `RouteRecordRaw` from `vue-router`
 ### 📝 Routing Conventions
@@ -127,4 +135,20 @@ export default defineConfig({
 })
 ```
+### 💡 Troubleshooting
+**Issue**: Route path shows error: *Cannot find module "/src/pages/xxx.vue" or its corresponding type declarations.* Unable to navigate to the file with F12.
+**Solution**: Add the following configuration to the `compilerOptions` in your `jsconfig.json` or `tsconfig.json`:
+```json
+{
+  "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+      "/src/*": ["src/*"]
+    }
+  }
+}
+```
 [中文文档](./README.zh_CN.md)

package/README.zh_CN.md CHANGED Viewed

@@ -45,12 +45,20 @@ export default defineConfig({
 ### ⚙️ 配置选项
-| 选项            | 类型       | 默认值                   | 描述                                  |
-| --------------- | ---------- | ------------------------ | ------------------------------------- |
-| `pagesFolder`   | `string`   | `'src/pages'`            | 页面文件夹路径                        |
-| `ignoreFolders` | `string[]` | `['components']`         | 生成路由时忽略的文件夹                |
-| `routesPath`    | `string`   | `'src/router/routes.js'` | 生成的路由文件路径，也可以是`.ts`文件 |
-| `nested`        | `boolean`  | `false`                  | 是否生成嵌套路由                      |
+| 选项            | 类型       | 默认值           | 描述                                                                                      |
+| --------------- | ---------- | ---------------- | ----------------------------------------------------------------------------------------- |
+| `pagesFolder`   | `string`   | `'src/pages'`    | 页面文件夹路径                                                                            |
+| `ignoreFolders` | `string[]` | `['components']` | 生成路由时忽略的文件夹                                                                    |
+| `routesPath`    | `string`   | 自动检测         | 生成的路由文件路径，根据 `tsconfig.json` 是否存在自动检测（存在则为 `.ts`，否则为 `.js`） |
+| `nested`        | `boolean`  | `false`          | 是否生成嵌套路由                                                                          |
+### 📘 TypeScript 支持
+本插件对 TypeScript 提供一流支持：
+- **自动检测**：通过检查 `tsconfig.json` 自动检测 TypeScript 项目
+- **类型定义**：为 TypeScript 项目生成路由时，插件会自动包含 `RouteMeta` 和 `GeneratedRoute` 的类型定义
+- **路由类型**：生成的路由使用 `vue-router` 的 `RouteRecordRaw` 进行正确的类型标注
 ### 📝 路由规则
@@ -123,8 +131,24 @@ export default defineConfig({
       routesPath: 'src/router/routes.js',
       nested: true
     })
-  ]
+  ],
 })
 ```
+### 💡 常见问题
+1、路由的path报红：*找不到模块“/src/pages/xxx.vue”或其相应的类型声明。*，按F12无法跳转至对应的文件
+解决方法：在 jsconfig.json 或者 tsconfig.json 的 compilerOptions中添加如下配置
+```json
+{
+  "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+      "/src/*": ["src/*"]
+    }
+  }
+}
+```
 [English Documentation](./README.md)

package/dist/index.d.ts CHANGED Viewed

@@ -1,5 +1,40 @@
 import { Plugin } from 'vite';
+/**
+ * Route meta information
+ */
+interface RouteMeta {
+    /** Route title */
+    title?: string;
+    /** Route icon */
+    icon?: string;
+    /** Whether authentication is required */
+    requiresAuth?: boolean;
+    /** Whether the route is enabled */
+    enabled?: boolean;
+    /** Custom properties */
+    [key: string]: unknown;
+}
+/**
+ * Internal route representation used during generation
+ */
+interface InternalRoute {
+    /** Route name */
+    name: string;
+    /** Route path */
+    path: string;
+    /** Redirect path */
+    redirect?: string;
+    /** Route component placeholder */
+    component?: string;
+    /** Route meta information */
+    meta: RouteMeta;
+    /** Parent route name (for nested routes) */
+    parent?: string;
+    /** Child routes */
+    children?: InternalRoute[];
+}
 /**********************************
  * @Author: Ronnie Zhang
  * @LastEditor: Ronnie Zhang
@@ -8,6 +43,25 @@ import { Plugin } from 'vite';
  * Copyright © 2023 Ronnie Zhang(大脸怪) | https://isme.top
  **********************************/
+/**
+ * Generated route record with proper typing for vue-router
+ */
+interface GeneratedRoute {
+    /** Route name */
+    name: string;
+    /** Route path */
+    path: string;
+    /** Redirect path */
+    redirect?: string;
+    /** Route component */
+    component?: () => Promise<any>;
+    /** Route meta information */
+    meta: RouteMeta;
+    /** Parent route name (for nested routes) */
+    parent?: string;
+    /** Child routes */
+    children?: GeneratedRoute[];
+}
 interface Options {
     /**
      * pages folder
@@ -23,8 +77,9 @@ interface Options {
     ignoreFolders: string[];
     /**
      * routes file path, It can also be a ts file，such as `src/router/routes.ts`
+     * Auto-detected based on tsconfig.json presence if not specified
      *
-     * @default src/router/routes.js
+     * @default src/router/routes.ts (if tsconfig.json exists) or src/router/routes.js
      */
     routesPath: string;
     /**
@@ -36,4 +91,4 @@ interface Options {
 }
 declare function VitePluginGeneroutes(options?: Partial<Options>): Plugin;
-export { VitePluginGeneroutes as default };
+export { type GeneratedRoute, type InternalRoute, type Options, type RouteMeta, VitePluginGeneroutes, VitePluginGeneroutes as default };

package/dist/index.js CHANGED Viewed

@@ -61,13 +61,18 @@ function findDuplicateRoutes(routes) {
 // src/index.ts
 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");
+    throw new Error("routesPath must be a js or ts file path, such as src/router/routes.js");
   let rootDir;
+  let routesPath;
+  let isTypeScript;
   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 detectTypeScriptProject() {
+    const tsconfigPath = path.resolve(rootDir, "tsconfig.json");
+    return fs.existsSync(tsconfigPath);
+  }
   function generateMenusAndRoutes() {
     const pages = globSync(`${pagesFolder}/**/*.vue`, { ignore: ignoreFolders.map((folder) => `${pagesFolder}/**/${folder}/**`) });
     const routes = pages.map((filePath) => {
@@ -89,7 +94,7 @@ function VitePluginGeneroutes(options = {}) {
         meta,
         parent: defineOptions.parent
       };
-    }).filter(Boolean);
+    }).filter((route) => route !== null);
     const { duplicateNames, duplicatePaths } = findDuplicateRoutes(routes);
     if (duplicateNames.length)
       console.warn(`Warning: Duplicate names found in routes: ${duplicateNames.join(", ")}`);
@@ -101,13 +106,48 @@ function VitePluginGeneroutes(options = {}) {
   }
   async function writerRoutesFile(isInit = false) {
     const { routes } = generateMenusAndRoutes();
+    const typeDefinitions = isTypeScript ? `
+import type { RouteRecordRaw } from 'vue-router'
+/**
+ * Route meta information
+ */
+export interface RouteMeta {
+  /** Page title */
+  title?: string
+  /** Page icon */
+  icon?: string
+  /** Page code */
+  code?: string
+  /** Whether authentication is required */
+  requireAuth?: boolean
+  /** Whether to keep alive */
+  keepAlive?: boolean
+  /** Whether it's the home page */
+  isHome?: boolean
+  /** Whether it's a login page */
+  isLogin?: boolean
+  /** Custom properties */
+  [key: string]: unknown
+}
+/**
+ * Generated route type with proper typing
+ */
+export type GeneratedRoute = RouteRecordRaw & {
+  meta?: RouteMeta
+  children?: GeneratedRoute[]
+}
+` : "";
+    const routesType = isTypeScript ? ": GeneratedRoute[]" : "";
     let routesStr = `
     // Generated by vite-plugin-generoutes, don't modify it directly.
-    export const routes = ${JSON.stringify(routes, null, 2)}
+    ${typeDefinitions}
+    export const routes${routesType} = ${JSON.stringify(routes, null, 2)}
     `;
     routesStr = routesStr.replace(/"##(.*)##"/g, (_, p1) => `async () => ({...(await import('${p1.split("@@")[0]}')).default, name: '${p1.split("@@")[1]}'})`);
-    routesStr = await prettier.format(routesStr, { parser: "babel", semi: false, singleQuote: true });
+    const parser = isTypeScript ? "typescript" : "babel";
+    routesStr = await prettier.format(routesStr, { parser, semi: false, singleQuote: true });
     const filePath = path.resolve(rootDir, routesPath);
     await fs.ensureDir(path.dirname(filePath));
     fs.writeFileSync(filePath, routesStr);
@@ -118,6 +158,9 @@ function VitePluginGeneroutes(options = {}) {
     name: "vite-plugin-generoutes",
     async configResolved(config) {
       rootDir = config.root;
+      const isTs = detectTypeScriptProject();
+      routesPath = options.routesPath || (isTs ? "src/router/routes.ts" : "src/router/routes.js");
+      isTypeScript = routesPath.endsWith(".ts");
       await writerRoutesFile(true);
     },
     configureServer(server) {
@@ -162,5 +205,6 @@ function parseDefineOptions(filePath, content) {
 }
 var index_default = VitePluginGeneroutes;
 export {
+  VitePluginGeneroutes,
   index_default as default
 };

package/package.json CHANGED Viewed

@@ -1,82 +1,89 @@
-{
-  "name": "vite-plugin-generoutes",
-  "type": "module",
-  "version": "1.0.1",
-  "packageManager": "pnpm@10.6.2",
-  "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": "^6.1.0"
-  },
-  "dependencies": {
-    "@antfu/utils": "^9.1.0",
-    "@vue/compiler-sfc": "^3.5.13",
-    "chalk": "^5.4.1",
-    "fs-extra": "^11.3.0",
-    "glob": "^11.0.1",
-    "prettier": "^3.5.3"
-  },
-  "devDependencies": {
-    "@antfu/eslint-config": "^4.10.1",
-    "@types/fs-extra": "^11.0.4",
-    "@types/node": "^20.17.24",
-    "bumpp": "^10.1.0",
-    "eslint": "^9.22.0",
-    "esno": "^4.8.0",
-    "lint-staged": "^15.5.0",
-    "pnpm": "^10.6.2",
-    "rimraf": "^5.0.10",
-    "simple-git-hooks": "^2.11.1",
-    "taze": "^19.0.2",
-    "tsup": "^8.4.0",
-    "typescript": "^5.8.2",
-    "unbuild": "^3.5.0",
-    "vitest": "^3.0.8"
-  },
-  "simple-git-hooks": {
-    "pre-commit": "pnpm lint-staged"
-  },
-  "lint-staged": {
-    "*": "eslint --fix"
-  }
-}
+{
+  "name": "vite-plugin-generoutes",
+  "type": "module",
+  "version": "1.1.0-beta.3",
+  "packageManager": "pnpm@10.6.2",
+  "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": "^6.1.0",
+    "vue-router": "^4.0.0"
+  },
+  "peerDependenciesMeta": {
+    "vue-router": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "@antfu/utils": "^9.1.0",
+    "@vue/compiler-sfc": "^3.5.13",
+    "chalk": "^5.4.1",
+    "fs-extra": "^11.3.0",
+    "glob": "^11.0.1",
+    "prettier": "^3.5.3"
+  },
+  "devDependencies": {
+    "@antfu/eslint-config": "^4.10.1",
+    "@types/fs-extra": "^11.0.4",
+    "@types/node": "^20.17.24",
+    "bumpp": "^10.1.0",
+    "eslint": "^9.22.0",
+    "esno": "^4.8.0",
+    "lint-staged": "^15.5.0",
+    "pnpm": "^10.6.2",
+    "rimraf": "^5.0.10",
+    "simple-git-hooks": "^2.11.1",
+    "taze": "^19.0.2",
+    "tsup": "^8.4.0",
+    "typescript": "^5.8.2",
+    "unbuild": "^3.5.0",
+    "vitest": "^3.0.8",
+    "vue-router": "^4.5.0"
+  },
+  "simple-git-hooks": {
+    "pre-commit": "pnpm lint-staged"
+  },
+  "lint-staged": {
+    "*": "eslint --fix"
+  }
+}