@soybeanjs/vite-plugin-vue-page-route

A Vite plugin for vue, auto generate route info by page, include route declaration, route file import, route module const.

Usage

1import { defineConfig } from 'vite';
2import pageRoute from '@soybeanjs/vite-plugin-vue-page-route';
3
4export default defineConfig({
5  plugins: [pageRoute({
6    pageDir: 'src/views', // default
7    pageGlobs: ['**/index.{vue,tsx,jsx}', '!**/components/**'], // default
8    routeDts: 'src/typings/page-route.d.ts', // default
9    routeModuleDir: 'src/router/modules', // default
10    routeModuleExt: 'ts', // default
11    routeModuleType: 'AuthRoute.Route', // default
12    /**
13     * @example _builtin_login => login
14     */
15    routeNameTansformer: name => name.replace(/^_([a-zA-Z]|[0-9]|$)+_*/, ''), // default
16    /**
17     * whether the route is lazy import
18     * @param name route name
19     * @example
20     * - the direct import
21     * ```ts
22     * import Home from './views/home/index.vue';
23     * ```
24     * - the lazy import
25     * ```ts
26     * const Home = import('./views/home/index.vue');
27     * ```
28     */
29    lazyImport: _name => true, // default
30    /**
31     * whether generate the route module
32     * @param name the route name, which is not transformed(not execute function routeNameTansformer)
33     * @returns boolean
34     */
35    onRouteModuleGenerate: name => !name.includes('_builtin') // not generate route module for the builtin routes, but other routes will
36  })]
37});