本插件扫描页面目录,生成 uni-app 需要的 pages.json。页面路由由文件路径推导,不用手写 pages.json。
安装
npm i -D @uni-helper/vite-plugin-uni-pages使用
UniPages() 必须放在 Uni() 之前。
vite.config.ts
import Uni from '@dcloudio/vite-plugin-uni'
import UniPages from '@uni-helper/vite-plugin-uni-pages'
import { defineConfig } from 'vite'
export default defineConfig({
plugins: [UniPages(), Uni()],
})
插件会扫描 src/pages,把发现的页面写进 src/pages.json。
类型支持
definePage 宏与 defineUniPages 的类型需要加进 tsconfig.json 或 jsconfig.json:
{
"compilerOptions": {
"types": ["@uni-helper/vite-plugin-uni-pages"]
}
}
{
"compilerOptions": {
"types": ["@uni-helper/vite-plugin-uni-pages"]
}
}
全局配置
在 pages.config.(ts|mts|cts|js|cjs|mjs|json) 里定义全局配置。文件位置与文件名由 configSource 控制。
pages.config.ts
import { defineUniPages } from '@uni-helper/vite-plugin-uni-pages'
export default defineUniPages({
// 也可以直接写 pages 字段,它的优先级最高
pages: [],
globalStyle: {
navigationBarTextStyle: 'black',
navigationBarTitleText: '@uni-helper',
},
})
页面配置
单个页面的配置写在页面文件的 definePage 宏里,详见 definePage。
不写 definePage 时,路径仍按文件位置自动生成。
读取页面元数据
导入虚拟模块即可拿到所有页面的元数据:
/// <reference types="@uni-helper/vite-plugin-uni-pages/client" />
import { pages } from 'virtual:uni-pages'
console.log(pages)
生成的文件
| 文件 | 说明 |
|---|---|
src/pages.json | 生成的页面配置,不要手改 |
uni-pages.d.ts | 页面路径的类型声明,由 dts 控制 |
pages.json 的生成格式由 minify、indent、eol、insertFinalNewline 控制。