自动生成配置

配置自动生成 pages.json 和 manifest.json 文件

@uni-helper/unh 提供了自动生成配置功能,可以在项目启动前自动生成 pages.jsonmanifest.json 文件,解决使用 vite-plugin-uni-pagesvite-plugin-uni-manifest 等插件时的文件依赖问题。

基本配置

unh.config.ts 中配置自动生成选项:

unh.config.ts
import { defineConfig } from '@uni-helper/unh'

export default defineConfig({
  // 自动生成配置
  autoGenerate: {
    // 输出目录,默认为 'src'
    outDir: 'src',
    // 是否自动生成 pages.json
    pages: true,
    // 是否自动生成 manifest.json
    manifest: true,
  },
})

配置选项

outDir

outDirstring
'src'
自动生成的文件输出目录

pages

pagesboolean | BuildPhase[]
false
是否自动生成 pages.json
  • true 在所有阶段自动生成 pages.json
  • BuildPhase[] 指定在哪些阶段生成,如 ['build', 'dev']

manifest

manifestboolean | ManifestOptions & { commands?: BuildPhase[] }
false
是否自动生成 manifest.json
  • true 在所有阶段自动生成 manifest.json
  • 对象形式可配置更多选项

ManifestOptions

minifyboolean
false
是否压缩 manifest.json
insertFinalNewlineboolean
false
是否在 manifest.json 末尾插入换行符
commandsBuildPhase[]
指定在哪些命令阶段生成 manifest.json

高级配置示例

unh.config.ts
import { defineConfig } from '@uni-helper/unh'

export default defineConfig({
  autoGenerate: {
    outDir: 'src',
    // 只在 dev 和 build 阶段生成 pages.json
    pages: ['dev', 'build'],
    // 配置 manifest.json 的高级选项
    manifest: {
      minify: true,
      insertFinalNewline: true,
      commands: ['build'], // 只在 build 阶段生成
    },
  },
})

This site is powered by Nuxt