XPack 组件接口
set_title
- 设置包组件的简单描述
函数原型
API
set_title(title: <string>)参数说明
| 参数 | 描述 |
|---|---|
| title | 组件标题字符串 |
用法说明
xpack_component("LongPath")
set_title("Enable Long Path")set_description
- 设置包组件的详细描述
函数原型
API
set_description(description: <string>)参数说明
| 参数 | 描述 |
|---|---|
| description | 组件详细描述字符串 |
用法说明
xpack_component("LongPath")
set_description("Increases the maximum path length limit, up to 32,767 characters (before 256).")set_default
- 设置包组件的默认启用状态
函数原型
API
set_default(default: <boolean>)参数说明
| 参数 | 描述 |
|---|---|
| default | 是否默认启用（布尔值） |
用法说明
通常包组件都会被默认启用，但是我们也可以使用这个接口，默认禁用这个组件，仅仅当用户安装包时候，选择勾选此组件，才会被启用安装。
xpack_component("LongPath")
set_default(false)
set_title("Enable Long Path")on_load
- 自定义加载脚本
函数原型
API
on_load(script: <function (component)>)参数说明
| 参数 | 描述 |
|---|---|
| script | 加载脚本函数，参数为component |
用法说明
自定义加载脚本，用于实现特定的组件配置逻辑。
我们可以在 on_load 自定义脚本域中，进一步灵活的配置包组件。
xpack_component("test")
on_load(function (component)
local package = component:package()
-- TODO
end)before_installcmd
- 添加组件安装之前的脚本
函数原型
API
before_installcmd(script: <function (component, batchcmds)>)参数说明
| 参数 | 描述 |
|---|---|
| script | 安装前脚本函数，参数为component和batchcmds |
它不会重写整个安装脚本，但是会在现有的安装脚本执行之前，新增一些自定义的安装脚本：
xpack_component("test")
before_installcmd(function (component, batchcmds)
batchcmds:mkdir(package:installdir("resources"))
batchcmds:cp("src/assets/*.txt", package:installdir("resources"), {rootdir = "src"})
batchcmds:mkdir(package:installdir("stub"))
end)需要注意的是，通过 batchcmds 添加的 cp, mkdir 等命令都不会被立即执行，而是仅仅生成一个命令列表，后面实际生成包的时候，会将这些命令，翻译成打包命令。
它跟 xpack 的 before_installcmd 使用是完全一样的，唯一的区别是，仅仅当这个组件被启用时候，才会执行这里的安装脚本。
on_installcmd
- 重写组件的安装脚本
函数原型
API
on_installcmd(script: <function (component, batchcmds)>)参数说明
| 参数 | 描述 |
|---|---|
| script | 安装脚本函数，参数为component和batchcmds |
用法说明
自定义安装脚本，用于实现特定的组件安装逻辑。
这会重写整个组件的安装脚本，类似 xpack 的 on_installcmd。
xpack_component("test")
on_installcmd(function (component, batchcmds)
-- TODO
end)after_installcmd
- 添加组件安装之后的脚本
函数原型
API
after_installcmd(script: <function (component, batchcmds)>)参数说明
| 参数 | 描述 |
|---|---|
| script | 安装后脚本函数，参数为component和batchcmds |
用法说明
在组件安装完成后执行的自定义脚本，用于后处理操作。
在组件安装之后，会执行这里的脚本，类似 xpack 的 after_installcmd。
xpack_component("test")
after_installcmd(function (component, batchcmds)
-- TODO
end)before_uninstallcmd
- 添加组件卸载之前的脚本
函数原型
API
before_uninstallcmd(script: <function (component, batchcmds)>)参数说明
| 参数 | 描述 |
|---|---|
| script | 卸载前脚本函数，参数为component和batchcmds |
在组件安装之后，会执行这里的脚本，类似 xpack 的 before_uninstallcmd。
xpack_component("test")
before_uninstallcmd(function (component, batchcmds)
-- TODO
end)on_uninstallcmd
- 重写组件卸载的脚本
函数原型
API
on_uninstallcmd(script: <function (component, batchcmds)>)参数说明
| 参数 | 描述 |
|---|---|
| script | 卸载脚本函数，参数为component和batchcmds |
用法说明
自定义卸载脚本，用于实现特定的组件卸载逻辑。
这会重写整个组件的卸载脚本，类似 xpack 的 on_uninstallcmd。
xpack_component("test")
on_uninstallcmd(function (component, batchcmds)
-- TODO
end)after_uninstallcmd
- 添加组件卸载之后的脚本
函数原型
API
after_uninstallcmd(script: <function (component, batchcmds)>)参数说明
| 参数 | 描述 |
|---|---|
| script | 卸载后脚本函数，参数为component和batchcmds |
用法说明
在组件卸载完成后执行的自定义脚本，用于后处理操作。
在组件卸载之后，会执行这里的脚本，类似 xpack 的 before_uninstallcmd。
xpack_component("test")
before_uninstallcmd(function (component, batchcmds)
-- TODO
end)add_sourcefiles
- 添加组件源文件
函数原型
API
add_sourcefiles(files: <string|array>, ..., {
prefixdir = <string>,
rootdir = <string>,
filename = <string>
})参数说明
| 参数 | 描述 |
|---|---|
| files | 源文件模式字符串或数组 |
| ... | 可变参数，可传递多个文件模式 |
| prefixdir | 安装前缀目录 |
| rootdir | 源文件根目录 |
| filename | 目标文件名 |
这类似于 xpack 的 add_sourcefiles，但这里仅仅当组件被启用后，才会将这些源文件打入安装包。
add_installfiles
- 添加组件二进制安装文件
函数原型
API
add_installfiles(files: <string|array>, ..., {
prefixdir = <string>,
rootdir = <string>,
filename = <string>
})参数说明
| 参数 | 描述 |
|---|---|
| files | 安装文件模式字符串或数组 |
| ... | 可变参数，可传递多个文件模式 |
| prefixdir | 安装前缀目录 |
| rootdir | 源文件根目录 |
| filename | 目标文件名 |
用法说明
这类似于 xpack 的 add_installfiles，但这里仅仅当组件被启用后，才会将这些二进制文件打入安装包。