Harmony鸿蒙应用开发：工具常用命令-ohpm run

执行用户自定义脚本。

不入流Android开发

1172人浏览 · 2024-06-26 15:56:39

不入流Android开发 · 2024-06-26 15:56:39 发布

执行用户自定义脚本。

命令格式

ohpm run [options] <script_name> [-- <args...>]

功能描述

指定运行定义在模块的 oh-package.json5 文件中 scripts 对象内的脚本。
scripts对象内部支持"key":"value"方式配置多个待执行脚本。如以下示例所示，scriptName 1、scriptName 2、scriptName 3为脚本别名（scriptName）；“echo hello”等为（scriptContent），后续内容均参考此说明。
oh-package.json5中scripts配置示例：

{               
  "scripts": {
    "scriptName1": "echo hello",
    " scriptName 2": "ohpm run scriptName 1",
    " scriptName 3": "node test.js -- -paramKey1 paramValue1 -paramKey2=paramValue2 --paramKey3 paramValue3"
  }
}

脚本内容中可以用ohpm run引用同一个 oh-package.json5 文件中其它脚本别名，如scriptName 2；ohpm run 引用关系是一个有向无环图，不支持递归或循环引用。
在解析脚本内容出错时，ohpm run命令将直接提示相应错误。比如，脚本内容中引用了一个在同一oh-package.json5文件中不存在的脚本别名；或在执行ohpm run时，发现脚本别名引用关系存在环的情况。

传递参数

ohpm run命令可以通过标识符‘--‘覆盖被引用脚本的参数或为被引用脚本传递额外的参数，如：
```
ohpm run scriptName 3 -- -paramKey1 newValue -paramKey4 paramValue4
```
该示例表明，脚本scriptName 3的参数paramKey1会被替换为newValue, 并新增一个参数paramKey4。

如果脚本内容为ohpm run scriptName且使用了标识符“--”，则该scriptName对应的脚本内容不能再包含ohpm run的描述，避免嵌套引用。

支持多命令

支持 && 和 || 两种命令连接符（&& 和 || 没有优先级区分，命令从左到右执行，不支持用括号来改变各个子命令的优先级）。

约束

约束项	说明
scriptKey 命名约束	合法的 scriptKey 的名字可以包含字母（包含大小写），数字，ASCII 冒号 :，ASCII下划线 _ ，ASCII链接符 -，首字母必须是小写字母
scriptContent 约束	合法的scriptContent不能引用除ohpm run以外的其它ohpm命令
scriptContent 中使用 ohpm run 的约束	1、ohpm run 依赖的其它script别名必须在同一 oh-package.json5 中存在 2、ohpm run 引用关系是一个有向无环图，不支持递归或循环引用

约束项

说明

scriptKey 命名约束

合法的 scriptKey 的名字可以包含字母（包含大小写），数字，ASCII 冒号 :，ASCII下划线 _ ，ASCII链接符 -，首字母必须是小写字母

scriptContent 约束

合法的scriptContent不能引用除ohpm run以外的其它ohpm命令

scriptContent 中使用 ohpm run 的约束

1、ohpm run 依赖的其它script别名必须在同一 oh-package.json5 中存在

2、ohpm run 引用关系是一个有向无环图，不支持递归或循环引用

Options

prefix

可以通过 --prefix 指定包的根目录，该目录下必须存在 oh-package.json5 文件。不支持通过这种方式调用依赖包中的脚本别名。

ohpm run --prefix <path> <脚本别名>

示例

参数传递的使用示例

ohpm run script_name -- -agr1=1 --arg2=2 -arg3 3 --arg4 4

运行 script_name 的脚本，并指定脚本中参数agr1，agr2，agr3，agr4，取值分别为1，2，3，4，以上四种参数传递的方法均可生效。

oh-package.json5配置如下：

{
  "name": "example",
  "version": "1.0.0",
  "description": "this is an example for ohpm run.",
  "main": "./src/index.ets",
  "author": "oh",
  "license": "ISC",
  "scripts": {
    "testLogic": "ohpm run testFail || ohpm run testSuc && ohpm run testSuc",
    "testFail": "test1",
    "testSuc": "echo hello"
  }
  ...
}

成功示例

执行脚本testSuc，如下所示：

ohpm run testSuc

执行结果：

失败示例

执行脚本testFail，如下所示：

ohpm run testFail

执行结果：

逻辑符(&&、||)使用示例

执行脚本testLogic，如下所示：

ohpm run testLogic

执行结果：

最后

有很多小伙伴不知道学习哪些鸿蒙开发技术？不知道需要重点掌握哪些鸿蒙应用开发知识点？而且学习时频繁踩坑，最终浪费大量时间。所以有一份实用的鸿蒙（HarmonyOS NEXT）资料用来跟着学习是非常有必要的。

点击领取→纯血版全套鸿蒙HarmonyOS学习资料（安全链接，放心点击）

这份鸿蒙（HarmonyOS NEXT）资料包含了鸿蒙开发必掌握的核心知识要点，内容包含了（ArkTS、ArkUI开发组件、Stage模型、多端部署、分布式应用开发、音频、视频、WebGL、OpenHarmony多媒体技术、Napi组件、OpenHarmony内核、（南向驱动、嵌入式等）鸿蒙项目实战等等）鸿蒙（HarmonyOS NEXT）技术知识点。

希望这一份鸿蒙学习资料能够给大家带来帮助，有需要的小伙伴自行领取，限时开源，先到先得~无套路领取！！

鸿蒙（HarmonyOS NEXT）最新学习路线