vite-plugin-vue-block-routes 1.0.0

package/client.d.ts

@@ -0,0 +1,5 @@
+declare module 'virtual:generated-routes' {
+  import type { RouteRecordRaw } from 'vue-router';
+  const routes: RouteRecordRaw[];
+  export default routes;
+}

package/dist/index.cjs

@@ -0,0 +1,96 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  default: () => vueBlockRoutes
+});
+module.exports = __toCommonJS(index_exports);
+var import_compiler_sfc = require("@vue/compiler-sfc");
+var import_fast_glob = __toESM(require("fast-glob"), 1);
+var import_fs = __toESM(require("fs"), 1);
+var import_path = __toESM(require("path"), 1);
+function vueBlockRoutes(options = {}) {
+  const virtualModuleId = "virtual:generated-routes";
+  const resolvedVirtualModuleId = "\0" + virtualModuleId;
+  const pagesDir = options.pagesDir || "src/pages";
+  return {
+    name: "vite-plugin-vue-block-routes",
+    // 1. 拦截虚拟模块导入
+    resolveId(id) {
+      if (id === virtualModuleId) {
+        return resolvedVirtualModuleId;
+      }
+    },
+    // 2. 加载虚拟模块内容
+    async load(id) {
+      if (id === resolvedVirtualModuleId) {
+        const files = await (0, import_fast_glob.default)(`${pagesDir}/**/*.vue`, { cwd: process.cwd() });
+        const routes = [];
+        for (const file of files) {
+          const filePath = import_path.default.resolve(process.cwd(), file);
+          const content = import_fs.default.readFileSync(filePath, "utf-8");
+          const { descriptor } = (0, import_compiler_sfc.parse)(content);
+          const routeBlock = descriptor.customBlocks.find((b) => b.type === "route");
+          if (routeBlock) {
+            try {
+              const routeData = JSON.parse(routeBlock.content.trim());
+              const componentPath = `/${file}`;
+              const routeString = `{
+                path: '${routeData.path || "/" + import_path.default.basename(file, ".vue")}',
+                name: '${routeData.name || import_path.default.basename(file, ".vue")}',
+                component: () => import('${componentPath}'),
+                meta: ${JSON.stringify(routeData.meta || {})}
+              }`;
+              routes.push(routeString);
+            } catch (e) {
+              console.error(`[vite-plugin] Error parsing route block in ${file}:`, e);
+            }
+          }
+        }
+        return `export default [${routes.join(",\n")}]`;
+      }
+    },
+    // 3. 处理 HMR (热更新)
+    // 当 Vue 文件变化时，如果 route 块变了，需要通知 Vite 重新加载虚拟模块
+    handleHotUpdate({ file, server }) {
+      if (file.includes(pagesDir) && file.endsWith(".vue")) {
+        const mod = server.moduleGraph.getModuleById(resolvedVirtualModuleId);
+        if (mod) {
+          server.moduleGraph.invalidateModule(mod);
+          server.ws.send({
+            type: "full-reload",
+            path: "*"
+          });
+        }
+      }
+    }
+  };
+}

package/dist/index.d.cts

@@ -0,0 +1,8 @@
+import { Plugin } from 'vite';
+
+interface PluginOptions {
+    pagesDir?: string;
+}
+declare function vueBlockRoutes(options?: PluginOptions): Plugin;
+
+export { vueBlockRoutes as default };

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+import { Plugin } from 'vite';
+
+interface PluginOptions {
+    pagesDir?: string;
+}
+declare function vueBlockRoutes(options?: PluginOptions): Plugin;
+
+export { vueBlockRoutes as default };

package/dist/index.js

@@ -0,0 +1,65 @@
+// src/index.ts
+import { parse } from "@vue/compiler-sfc";
+import glob from "fast-glob";
+import fs from "fs";
+import path from "path";
+function vueBlockRoutes(options = {}) {
+  const virtualModuleId = "virtual:generated-routes";
+  const resolvedVirtualModuleId = "\0" + virtualModuleId;
+  const pagesDir = options.pagesDir || "src/pages";
+  return {
+    name: "vite-plugin-vue-block-routes",
+    // 1. 拦截虚拟模块导入
+    resolveId(id) {
+      if (id === virtualModuleId) {
+        return resolvedVirtualModuleId;
+      }
+    },
+    // 2. 加载虚拟模块内容
+    async load(id) {
+      if (id === resolvedVirtualModuleId) {
+        const files = await glob(`${pagesDir}/**/*.vue`, { cwd: process.cwd() });
+        const routes = [];
+        for (const file of files) {
+          const filePath = path.resolve(process.cwd(), file);
+          const content = fs.readFileSync(filePath, "utf-8");
+          const { descriptor } = parse(content);
+          const routeBlock = descriptor.customBlocks.find((b) => b.type === "route");
+          if (routeBlock) {
+            try {
+              const routeData = JSON.parse(routeBlock.content.trim());
+              const componentPath = `/${file}`;
+              const routeString = `{
+                path: '${routeData.path || "/" + path.basename(file, ".vue")}',
+                name: '${routeData.name || path.basename(file, ".vue")}',
+                component: () => import('${componentPath}'),
+                meta: ${JSON.stringify(routeData.meta || {})}
+              }`;
+              routes.push(routeString);
+            } catch (e) {
+              console.error(`[vite-plugin] Error parsing route block in ${file}:`, e);
+            }
+          }
+        }
+        return `export default [${routes.join(",\n")}]`;
+      }
+    },
+    // 3. 处理 HMR (热更新)
+    // 当 Vue 文件变化时，如果 route 块变了，需要通知 Vite 重新加载虚拟模块
+    handleHotUpdate({ file, server }) {
+      if (file.includes(pagesDir) && file.endsWith(".vue")) {
+        const mod = server.moduleGraph.getModuleById(resolvedVirtualModuleId);
+        if (mod) {
+          server.moduleGraph.invalidateModule(mod);
+          server.ws.send({
+            type: "full-reload",
+            path: "*"
+          });
+        }
+      }
+    }
+  };
+}
+export {
+  vueBlockRoutes as default
+};

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "vite-plugin-vue-block-routes",
+  "version": "1.0.0",
+  "description": "Generate Vue Router config from SFC custom blocks",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "type": "module",
+  "files": [
+    "dist",
+    "client.d.ts"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts --clean",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "vite",
+    "vue",
+    "router",
+    "plugin"
+  ],
+  "peerDependencies": {
+    "vite": "^2.0.0 || ^3.0.0 || ^4.0.0 || ^5.0.0"
+  },
+  "dependencies": {
+    "@vue/compiler-sfc": "^3.0.0",
+    "fast-glob": "^3.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^25.0.3",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3"
+  }
+}