vite-plugin-pages ![]()
![]()
基于文件系统的 Vite 路由生成器
Usage
对于 Vite + Vue 而言，使用方式如下：
$ npm i vite-plugin-pages
import { createRouter } from 'vue-router'
import routes from '~pages'
const router = createRouter({
// ...
routes,
})<template>
<router-view />
</template>import Pages from 'vite-plugin-pages'
export default {
plugins: [
// ...
Pages(),
],
}同样是利用 Vite 的 Virtual Module，解析文件结构，生成对应符合 vue-router 的路由配置 routes
例如对于下面的目录结构：
src
pages
blog
today
- index.vue
about
id
- nested.vue
- [id].vue
- about.vue
- [id].vue
- jsx.jsx
- [...all].vue
- main.ts
- vite.config.ts
生成的 routes 示例结果如下：
routes
[
{
component: () => import("/src/pages/blog/today/index.vue")
name: "blog-today",
path: "/blog/today",
props: true
},
{
component: () => import("/src/pages/jsx.jsx")
name: "blog-id",
path: "/jsx",
props: true,
meta: {
requiresAuth: false,
id: 1234
}
},
{
path: "/about",
component: () => import("/src/pages/about.vue"),
children: [
{
component: () => import("/src/pages/about/[id].vue"),
name: "about-user-id",
path: ":id",
children: [
{
component: () => import("/src/pages/about/[id]/nested.vue"),
name: "about-id-nested",
path: "nested",
props: true
}
],
props: true,
meta: {
requiresAuth: true
}
}
],
props: true,
meta: {
lang: "yml"
}
},
{
component: () => import("/src/pages/[...all].vue")
name: "all",
path: "/:all(.*)*",
props: true
},
{
component: () => import("/src/pages/blog/[id].vue")
name: "blog-id",
path: "/blog/:id",
props: true,
meta: {
requiresAuth: false
}
},
]原理
利用 vite 内部暴露的 paulmillr/chokidar 监听 pages 下面文件的的新增、变动、删除等
下面的作用就是监听 pages 目录下面的文件的增加，把结果收集到 _pageRouteMap 中
hannoeru/vite-plugin-pages/src/context.ts
Lines 45 to 90 #a638fe3
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
在源代码的 src 下面中，有 vue、react、solid 三种 resolver，用于适应不同的框架，我们还是以 Vue 举例子
下面是基于上面生成的 pageRouteMap 用于生成 Vue Router 的路由配置：
hannoeru/vite-plugin-pages/src/resolvers/vue.ts
Lines 63 to 159 #a638fe3
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
从 pageRouteMap，经过排序，父子关系建立，路由转换，最终得到 finalRoutes
hannoeru/vite-plugin-pages/src/resolvers/vue.ts
Lines 161 to 219 #a638fe3
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
经过 resolveVueRoutes 转换之后，就是最终的 ~pages 的值了
hannoeru/vite-plugin-pages/src/index.ts
Lines 50 to 67 #a638fe3
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67