vite-plugin-uni-platform-modifier

为属性、指令提供平台修饰符并按需编译

同一个属性在本插件里可以按平台写多份取值,例如 class.h5、@click.mp-weixin、v-text.app。插件在编译期按当前平台为每组属性保留匹配的那一份。没有平台匹配时保留默认值。

插件只处理 .vue 与 .nvue 文件。它用 @vue/compiler-dom 的模板 AST 定位属性,用 magic-string 改写源码并生成 sourcemap。

安装

npm i -D @uni-helper/vite-plugin-uni-platform-modifier

peer 依赖是 vite ^5.0.0。

配置

vite.config.ts
import Uni from '@dcloudio/vite-plugin-uni'
import UniPlatformModifier from '@uni-helper/vite-plugin-uni-platform-modifier'
import { defineConfig } from 'vite'

export default defineConfig({
  plugins: [Uni(), UniPlatformModifier()],
})

也提供具名导出,两种引入方式等价:

import { VitePluginUniPlatformModifier } from '@uni-helper/vite-plugin-uni-platform-modifier'

从 0.2.0 起,插件工厂函数名为 VitePluginUniPlatformModifier。旧名 VitePluginUniPlatformVOnModifier 是笔误,已移除。

编写代码

index.vue
<button
  v-text="'hello'"
  v-text.h5.mp-weixin="'h5&mp-weixin'"
  class.h5="h5-class"
  class="default-class"
  @click.h5="handleH5Click"
  @click="handleDefaultClick"
/>

编译结果

支持的修饰符

修饰符集合来自 @uni-helper/uni-env 导出的 builtInPlatforms。以实际安装的版本为准:

[
  'app',
  'app-android',
  'app-harmony',
  'app-ios',
  'app-plus',
  'h5',
  'mp-360',
  'mp-alipay',
  'mp-baidu',
  'mp-harmony',
  'mp-jd',
  'mp-kuaishou',
  'mp-lark',
  'mp-qq',
  'mp-toutiao',
  'mp-weixin',
  'mp-xhs',
  'quickapp-webview',
  'quickapp-webview-huawei',
  'quickapp-webview-union',
  'web',
]

匹配规则

匹配依据是当前构建的平台标识 UNI_PLATFORM。App 端还会参考 UNI_APP_PLATFORM 与 UNI_UTS_PLATFORM。快应用参考 UNI_SUB_PLATFORM。

h5 与 web 视为同一个浏览器目标,写任意一个都会生效。其余平台名按值精确匹配。

同一属性命中多个当前平台修饰符时,插件使用第一个,并在构建时输出警告。