第13章 oclif API 参考指南:命令结构与生命周期
API 参考 📄️ 命令 TypeScript 中一个基础命令的结构如下所示: 📄️ 命令参数 参数是传递给命令的位置参数。例如,如果用 mycli arg1 arg2 运行该命令,其声明方式如下: 🗃️ 命令标志 1 个项目 📄️ 配置 在命令内部,this.config 提供了对 Config 类的访问,该类包含你在命令中可用的有用属性和方法。以下是其方法和属性的列表: 📄️ 命令发现策略 当 oclif 加载插件时,必须找到该插件内所有可执行的命令。有三种策略用于发现这些命令: 📄️ 主题 随着 CLI 的增长,将命令嵌套在主题中会很有用。只需将命令文件放在子目录中即可支持此功能。例如,在 Salesforce CLI 中,我们有一个主题 sf config,其下包含 sf config set 和 sf config get 等命令。目录结构如下所示: 📄️ 主题分隔符 默认情况下,主题以冒号分隔,例如 mycommand。不过,如果你更喜欢使用空格,也可以选择该选项,例如 my awesome command。 📄️ 钩子 oclif 暴露了诸如 init 和 commandnotfound 等生命周期事件钩子。下方列出了所有生命周期事件。除了这些内置事件外,你还可以创建自己的事件,并允许命令/插件监听这些自定义事件。这是让多个插件相互交互的绝佳方式。 📄️ 插件 插件是提供实验性功能、允许用户扩展你的 CLI、将 CLI 拆分为模块化组件或在多个 CLI 之间共享功能的好方法。 📄️ 帮助类 oclif 开箱即用地为 CLI 提供了极佳帮助体验。用户可以通过 --help 标志调用帮助。 📄️ 性能 oclif 开箱即用地支持性能追踪,既针对 oclif 本身,也针对你的自定义代码。根据你的 bin 脚本实现方式,你可以用以下两种方式之一启用它。