@yme/vite-plugin-router-page v2.3.0

vite-plugin-router-page

Vite 插件，自动根据页面文件生成页面的路由声明文件, 基于 soybeanjs/vite-plugin-vue-page-route v1.0.3

• views -> pages
• index.vue -> page.vue
• typing -> @types
• 只生成数据和类型定义，不依赖 vue-router 等
• ✨ 2.2.0开始 react 也可以用了，首先定义一个全局类型 AppRouter.Component
• 加了备注关掉过滤

安装

pnpm add @yme/vite-plugin-router-page -D

用法

import {defineConfig} from 'vite';
import routerPage from '@yme/vite-plugin-router-page';

export default defineConfig({
  plugins: [
    routerPage({
      // 项目根目录, 默认为 process.cwd(), 一般不需要配置, Windows 环境下需要将 \ 替换为 /
      rootDir: process.cwd().replace(/\\/g, '/'),
      dir: 'src/pages',
      excludes: ['components'],
      dts: 'src/@types/router-page.d.ts',
      patterns: ['page.vue'],
      builtinRoute: {
        root: 'root',
        notFound: 'not-found',
      },
      pagesFormatter: (names) =>
        names.map((name) => {
          /** 系统的内置路由，该文件夹名称不作为RouteKey */
          const SYSTEM_VIEW = 'system-view_';
          return name.replace(SYSTEM_VIEW, '');
        }),
    }),
  ],
});