uni

二次封装的启动命令，可以自定义hooks

npm

pnpm

bun

yarn

npm i @uni-helper/uni

为什么需要 `@uni-helper/uni`

@uni-helper/uni 是对 uni-app 启动命令的二次封装，旨在解决开发过程中的特定问题。在标准的 uni-app 工作流中，启动命令会使用 fs 模块检查 pages.json 和 manifest.json 文件是否存在，若缺少这些文件将导致命令中断。

当使用 vite-plugin-uni-pages 和 vite-plugin-uni-manifest 等插件时，这些配置文件通常在构建过程中动态生成，而非预先存在。这种时序差异会导致启动命令失败，因为文件检查发生在文件生成之前。

@uni-helper/uni 通过引入自定义 hooks 机制，在执行实际启动命令前预先生成必要的配置文件，确保了开发流程的顺畅性。这种设计不仅解决了文件依赖问题，还为开发者提供了在项目启动前后执行自定义逻辑的灵活性。

@uni-helper/uni 还提供了平台别名功能，允许开发者在 uni.config.ts 中为不同平台配置简短别名。这一特性不仅简化了命令行操作，也优化了 package.json 中 scripts 部分的配置，提升了开发效率和项目可维护性。

使用

更新 package.json

package.json

{
  "scripts": {
    "dev": "unh dev",
    "build": "unh build",
    "prepare": "unh prepare"
  }
}

配置 uni.config.ts

uni.config.ts

import { defineConfig } from '@uni-helper/uni'

export default defineConfig({
  // 平台配置
  platform: {
    // 默认平台，当不指定平台时使用此平台
    default: 'h5',
    // 平台别名，可以使用短名称代替完整平台名称
    alias: {
      'h5': ['w', 'h'],
      'mp-weixin': ['wx'],
    },
  },
  // 准备阶段配置，可以自定义hooks
  prepare: {
    // 安装依赖时的钩子
    install() {
      console.log('install')
    },
    // 构建时的钩子，接收平台参数
    build(platform: string) {
      console.log('build:', platform)
    },
    // 开发时的钩子，接收平台参数
    dev(platform: string) {
      console.log('dev:', platform)
    },
  },
  // 自动生成配置
  autoGenerate: {
    // 是否自动生成页面配置
    pages: true,
    manifest: true,
  },
})