@tingyun-common/hvigor-plugin-build

听云 HarmonyOS NEXT 项目符号表文件上传的 hvigor 插件

安装

1. 在项目根目录 hvigor/hvigor-config.json5 中加入插件依赖

{
  "dependencies": {
    "@tingyun-common/hvigor-plugin-build": "0.1.0"
  }
}

2. 在工程级的hvigorfile.ts中注册插件

import { appTasks } from '@ohos/hvigor-ohos-plugin';
import { tingyunBuildPlugin } from '@tingyun-common/hvigor-plugin-build';

export default {
  system: appTasks,
  plugins: [
    tingyunBuildPlugin({
      beacon: '<beacon>',
      token: '<token>',
      appToken: '<appToken>',
    }),
    // ...
  ],
};

3. sync 工程
4. release 模式下构建, 观察构建日志数据, 可以看到符号表文件上传

插件配置项

type TingyunBuildPluginOptions = {
  // 上报的目录，如果用户没有设置, 插件内部会自动传入项目根目录
  include?: string[];
  // 上传地址, 也可以在configFile指定的配置文件中配置
  beacon?: string;
  // auth token, 也可以在configFile指定的配置文件中配置
  token?: string;
  // 应用 token, 也可以在configFile指定的配置文件中配置
  appToken?: string;
  // tingyun-cli配置文件路径
  configFile?: string;
  // 需要执行插件的buildMode, 默认为release
  buildMode?: string;
  // 应用版本
  appVersion?: string;
  // 构建ID
  buildId?: string;
  // 指定需要上传的product名称, 默认会在构建时自动获取
  product?: string;
  // 指定需要上传的target名称
  target?: string;
  // 需要上报的模块名(module.json5中的module.name), 默认上报工程下的全部模块
  modules?: string[];
  // 需要上报的包名(oh-package.json5中的name), 默认上报工程下的全部包
  packages?: string[];
  // 仅收集sourceMap上报开关, 默认false
  sourceMap?: boolean;
  // 仅收集nameCache上报开关, 默认false
  nameCache?: boolean;
  // 仅收集symbol上报开关, 默认false
  symbol?: boolean;
  // 输出目录
  output?: string;
  // 上传完成后移除打包的zip文件, 默认false
  removeOutput?: boolean;
  // 只打包不上报, 默认false
  noUpload?: boolean;
  // demangle每批参数长度, 默认4096
  demangleBatchSize?: number;
  // 重试次数, 默认0次
  uploadRetries?: number;
};