执行用户自定义脚本。
scripts对象内部支持"key":"value"方式配置多个待执行脚本。如以下示例所示,scriptName1、scriptName2、scriptName3为脚本别名(scriptName);“echo hello”等为脚本内容(scriptContent),后续内容均参考此说明。
{
"scripts": {
"scriptName1": "echo hello",
"scriptName2": "ohpm run scriptName1",
// 标识符"--"后可以通过'-p'或'--p'形式指定参数key, 可以通过' '或'='连接参数值
"scriptName3": "node test.js -- -paramKey1 paramValue1 -paramKey2=paramValue2 --paramKey3 paramValue3"
}
} ohpm run scriptName3 -- -paramKey1 newValue -paramKey4 paramValue4
该示例表明,脚本scriptName3的参数paramKey1会被替换为newValue, 并新增一个参数paramKey4。
约束项 | 说明 |
|---|---|
scriptKey 命名约束 | 合法的 scriptKey 的名字可以包含字母(包含大小写),数字,ASCII 冒号 :,ASCII下划线 _ ,ASCII链接符 -,首字母必须是小写字母 |
scriptContent 约束 | 合法的scriptContent不能引用除ohpm run以外的其它ohpm命令 |
scriptContent 中使用 ohpm run 的约束 | 1、ohpm run 依赖的其它script别名必须在同一 oh-package.json5 中存在 2、ohpm run 引用关系是一个有向无环图,不支持递归或循环引用 |
可以通过 --prefix 指定包的根目录,该目录下必须存在 oh-package.json5 文件。不支持通过这种方式调用依赖包中的脚本别名。
ohpm run --prefix <path> <脚本别名>
从ohpm 6.0.2.636版本开始,可以在命令后配置--log_level <string>参数,指定执行当前命令的日志级别(info、debug、warn、error),如果未指定该值则日志级别为.ohpmrc中配置的log_level的级别。
从ohpm 6.0.2.636版本开始,可以在命令后配置--debug参数,指定执行当前命令的日志级别为debug,该配置仅在当前命令行生效,不修改.ohpmrc中的日志级别,如果未指定该值则日志级别为.ohpmrc中配置的log_level的级别。
下列所有示例的scripts配置均来自如下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"
}
}