routerMeta(options?)
生成“页面文件路径 → 稳定组件名”JSON,适合 KeepAlive、权限元数据和路由缓存。
ts
routerMeta({
dir: "src/views",
output: "src/router/routes.generated.json",
key: ({ relativePath }) => `@/${relativePath}`,
});| 选项 | 默认值 | 说明 |
|---|---|---|
dir | "src/views" | 页面目录 |
output | "src/router/routes.generated.json" | 输出 JSON |
deep | true | 是否递归 |
extensions | vue, tsx, jsx | 页面扩展名 |
include | - | 页面过滤器 |
name | - | 自定义名称;默认优先读取静态 defineOptions({ name }) |
key | - | 自定义 JSON 键;默认 /<root 相对路径> |
indent | 2 | 0 到 10 的 JSON 缩进 |
debounce | 80 | 开发监听防抖毫秒数 |
只解析静态字符串形式的 defineOptions({ name: "..." });动态表达式会回退到文件名。
routerMeta 路由元数据
为路由缓存、KeepAlive 或权限配置生成页面文件路径与稳定组件名的 JSON 映射。
签名
ts
export function routerMeta(options: RouterMetaPluginOptions = {}): Plugin;示例
ts
import { routerMeta } from "fast-vite-plugins";
const plugin = routerMeta({ dir: "src/views", output: "src/router/routes.generated.json" });
export default { plugins: [plugin] };输入
| 输入值 | 输入值类型 | 必填/默认值 | 输入值说明 |
|---|---|---|---|
options | RouterMetaPluginOptions | 否,默认 {} | 页面扫描、命名、路径键、JSON 输出和监听配置。 |
返回
| 返回值 | 返回值类型 | 返回值说明 |
|---|---|---|
plugin | Plugin | 可直接加入 Vite plugins 的路由元数据生成插件。 |
