平台别名

为不同平台配置简短别名，简化命令行操作

npm
source

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

基本用法

在 unh.config.ts 中配置平台别名：

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

export default defineConfig({
  // 设置默认平台
  platform: 'h5',
  // 配置平台别名
  alias: {
    'mp-weixin': 'wx',
    'mp-alipay': ['ali', 'alipay'],
  },
})

使用示例

使用默认平台

当执行 unh dev 时，会根据 platform 配置自动选择 h5 平台：

terminal
unh dev
# 等同于: unh dev h5

使用别名

当执行 unh dev wx 时，会自动运行 unh dev mp-weixin：

terminal
unh dev wx
# 等同于: unh dev mp-weixin

同样，也可以使用配置的多个别名：

terminal
unh dev ali
# 等同于: unh dev mp-alipay

unh dev alipay
# 等同于: unh dev mp-alipay

配置说明

platform

defaultPlatform
'h5'
默认平台，当未指定平台时使用该平台

alias

aliasRecord<Platform, string | string[]>
平台别名配置，支持为每个平台配置单个或多个别名

内置平台

// https://github.com/uni-helper/unh/blob/main/src/constants/platform.ts
export const PLATFORM_DESCRIPTIONS = {
  // 应用
  'app': '通用应用平台',
  'app-plus': 'uni-app 应用平台',
  'app-android': 'Android 应用平台',
  'app-ios': 'iOS 应用平台',
  'app-harmony': '鸿蒙应用平台',

  // 自定义
  'custom': '自定义平台',

  // h5
  'h5': 'HTML5 网页平台',
  'h5:ssr': 'HTML5 服务端渲染平台',

  // 小程序
  'mp-alipay': '支付宝小程序',
  'mp-baidu': '百度小程序',
  'mp-harmony': '鸿蒙小程序',
  'mp-jd': '京东小程序',
  'mp-kuaishou': '快手小程序',
  'mp-lark': '飞书小程序',
  'mp-qq': 'QQ小程序',
  'mp-toutiao': '字节跳动小程序',
  'mp-weixin': '微信小程序',
  'mp-xhs': '小红书小程序',

  // 快应用
  'quickapp-webview': '快应用 WebView',
  'quickapp-webview-huawei': '华为快应用',
  'quickapp-webview-union': '快应用联盟',
} as const
在 GitHub 上编辑此页
安装
二次封装的启动命令，支持平台别名和自动生成配置
自定义Hooks
通过自定义hooks扩展unh功能，实现项目启动前后自定义逻辑
成为赞助商

This site is powered by Nuxt