进阶 oclif.io 2026-10-18 02:37:03 · 24 阅读

第31章 oclif 中的 Hooks 机制详解

Hooksoclif 提供生命周期事件钩子,例如 init 和 command_not_found。下方列出了所有生命周期事件。除了这些内置事件外,你还能创建自定义事件,并允许命令或插件监听这些自定义事件。这是让多个插件互相交互的好方法。 多个钩子会并行运行。此行为在未来版本中可能会变更。 TypeScript 中一个基础钩子的示例如下: import {Hook} from '@oclif/core'

const hook: Hook.Init = async function (options) {
console.log(`example init hook running before ${options.id}`)
}

export default hook
你还必须在 package.json 的 oclif 配置中,使用事件名称和钩子文件路径来声明该钩子: "oclif": {
"commands": "./lib/commands",
"hooks": {
"init": "./lib/hooks/init/example"
}
}
如果同一事件类型有多个国家钩子,可以用数组来声明。 "oclif": {
"commands": "./lib/commands",
"hooks": {
"init": [
"./lib/hooks/init/example",
"./lib/hooks/init/another_hook"
]
}
}
# 第31章 Hooks 使用 oclif generate hook myhook --event=init 可以创建 hook。 ## 生命周期事件 - init — CLI 初始化时运行,早于查找要执行的命令 - prerun — 在 init 之后、找到命令之后、命令真正执行之前运行 - command_not_found — 找不到命令时、错误信息展示之前运行 - command_incomplete — 命令不存在但与已有命令部分匹配时运行。仅在启用 flexible taxonomy 时生效,适合用于向用户展示所有匹配命令的提示场景。参见 Salesforce CLI 的实现 - jit_plugin_not_installed — 执行了来自 JIT 插件的命令但插件尚未安装时运行。参见 Salesforce CLI 的实现 - preparse — 在解析和校验 flag 与参数之前运行,适合需要在此时修改输入的场景。参见 Salesforce CLI 的实现。注意只有根 CLI 可以实现此事件 - postrun — 命令执行完毕且没有错误时运行 - finally — 命令执行完毕后运行,无论退出状态如何 ## 自定义事件 自定义事件和生命周期事件类似,只是需要手动调用 this.config.runHook() 来触发。 比如,你可以定义一个上报分析数据(analytics)的 post 函数,在命令提交分析遥测数据后执行。首先定义 hook: src/hooks/analytics/post.ts ```typescript const hook = async function (options: {id: string}) { // 将 options.id 上报到分析服务器的代码 } export default hook ``` package.json ```json "oclif": { "commands": "./lib/commands", "hooks": { "analytics": "./lib/hooks/analytics/post" }, }, ``` 然后在任意需要触发事件的命令中: ```typescript export class extends Command { async run() { // 触发 analytics 事件 await this.config.runHook('analytics', {id: 'my_command'}) } } ``` 如果需要在 hook 中退出 CLI,请使用 options.context.error() 或 options.context.exit()。直接抛出 Error 并不会让 CLI 退出——这是为了防止某个插件的 init hook 出问题后,导致 CLI 在每次执行命令时都立即失败。

评论 (0)