自定义Hooks

通过自定义hooks扩展unh功能，实现项目启动前后自定义逻辑

@uni-helper/unh 提供了强大的自定义hooks系统，允许开发者在项目启动前后执行自定义逻辑，实现更灵活的工作流程定制。

基本配置

在 unh.config.ts 中配置自定义hooks：

unh.config.ts

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

export default defineConfig({
  // 准备阶段配置，可以自定义hooks
  hooks: {
    // 安装依赖时的hooks
    prepare() {
      console.log('prepare')
    },
    // 开发前的hooks，接收平台参数
    dev({ platform, options, envData }) {
      console.log('dev:', platform, options, envData)
    },
    // 构建前的hooks，接收平台参数
    build({ platform, options, envData }) {
      console.log('build:', platform, options, envData)
    },
    // 构建后的hooks，接收平台参数
    onBuildAfter({ platform, options, envData }) {
      console.log('buildAfter:', platform, options, envData)
    },
  },
})

参数类型

prepare() => void | Promise<void>

安装依赖时执行，执行unh prepare时调用

build(params: HookParams) => void | Promise<void>

构建前执行，执行unh build时调用

dev(params: HookParams) => void | Promise<void>

开发前执行，执行unh dev时调用

onBuildAfter(params: HookParams) => void | Promise<void>

构建后执行，执行unh build后调用

interface HookParams {
  platform: string // 目标平台
  options: Record<string, any> // 命令行选项
  envData: Record<string, any> // 环境数据
}

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

成为赞助商

本页目录

基本配置
参数类型

点亮星星反馈问题