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

第10章 发布 oclif v2!

第10章 发布 oclif v2! 2022年1月12日 · 5分钟阅读 大家好,新年快乐!我们很高兴地宣布,已发布 oclif v2,它使用了全新的 @oclif/core 库!🎉 oclif v2 包含多项改进,旨在提升创建和使用 oclif CLI 的体验。 展望未来,我们计划停止对 oclif v1 及其相应库的更新,但关键安全修复除外。请参阅兼容性矩阵了解这些库的列表。为了给开发者预留从 v1 迁移到 v2 的时间,我们尚未完全停止支持 v1。但在未来的某个时间点,我们将归档 v1 仓库,并在 npm 上弃用其版本。 变更内容​ 仓库变更​ oclif 组织下的所有仓库现在均以 main 作为主分支,以 oclif-v1 作为遗留分支。main 分支对应 oclif v2,而 oclif-v1 分支对应 oclif v1。如果您发现某个仓库没有 main 分支,可以认为它未用于 oclif v2,并将在未来被弃用。 整合工具与库​ oclif-dev CLI 现已整合进 oclif。您不再需要安装单独的包来管理整个 CLI 的生命周期。 以下库已整合至 @oclif/core 下,并将在未来某个时间点被弃用。阅读迁移指南以了解如何更新您的 CLI 或插件以使用新的核心库。 @oclif/command @oclif/config @oclif/error @oclif/help @oclif/parser 告别单命令与多命令 CLI 的区分​ oclif v2 CLI 只有一种“类型”,但开发者可以拥有任意数量(极少或极多)的命令。因此,只有一个生成 CLI 的命令:oclif generate,取代了旧的 oclif single 和 oclif multi 命令。 Node 版本要求 > 12​ 为确保 oclif CLI 尽可能安全,目前所有 v2 库和插件仅支持 Node 12 或更高版本。未来,它们将仅支持 Node Maintenance(维护版本)或更高版本,具体定义请参考 Node 发布时间表:https://nodejs.org/en/about/releases/。 新增特性​ 新示例 CLI​ oclif-hello-world 是我们的新示例仓库。这也是运行 oclif generate 创建新 CLI 时使用的模板。该仓库将始终作为 oclif v2 CLI 外观的参考示例。 支持空格分隔命令​ oclif CLI 现在可以使用空格而非冒号来分隔主题和子命令。要启用此功能,只需在 package.json 的 oclif 配置中添加 “topicSeparator": " "。在我们的示例仓库中查看示例。 // 旧命令使用 :
$ mycli do:something
// 新的空格分隔命令
$ mycli do something
注意:空格分隔命令是向后兼容的。即使你为 CLI 启用了空格命令,用户仍然可以用 `:` 作为分隔符,这样已有的脚本不会因此失效。 全新的帮助输出 我们彻底重做了命令帮助信息的终端输出,实现更简单,阅读也更轻松。对比下面的截图,左侧是旧版输出,右侧是新版输出。 oclif v1oclif v2 可以看到新增了 flags 和 global flags 分区,示例的排版间距更合理,底部还有一个叫 Configuration Variables 的分区。这个分区默认并不包含在新版帮助输出中,但我们新增了自定义帮助分区的支持,sf CLI 就是用它来实现这个新分区的。 异步命令解析 我们还重写了初始化时的命令解析逻辑,提升了新 CLI 的性能。新的解析器是异步的,这让拥有大量命令或已安装插件的 CLI 运行速度大幅提升。 接下来会做什么? 发布 oclif v2 的目标之一,就是加强与 oclif 社区的互动。我们知道过去几年我们的参与度有所下降,很多 issue 和 PR 一直悬而未决。希望你最近已经感受到 oclif 维护者的活跃度和响应速度在提升;如果没有,欢迎随时在 oclif 仓库中 @admins 联系我们。 我们还打算对 oclif 社区成员进行访谈,收集反馈,优先处理大家认为最重要的功能和修复! 祝好, oclif 团队
参考资料 迁移指南 这份指南介绍了如何将 CLI 或插件从旧的 oclif v1 库升级到 oclif v2 所使用的全新 @oclif/core 库。 https://github.com/oclif/core/blob/main/MIGRATION.md 兼容性对照表 下表展示了 v1 的库和插件与新版 v2 的对应关系。升级插件和 CLI 到 v2 时,可以参照此表了解该移除什么、该切换到哪些版本。 oclif "v1"oclif "v2"Utility CLIsoclif@<2
@oclif/dev-cli@<2oclif@>=2Main packages@oclif/command
@oclif/config
@oclif/errors
@oclif/parser
@oclif/plugin-help
@oclif/coreNode LTSNode v8-14Node v12+ (at time of writing)TypeScript
@oclif/core>=1Node LTSNode v8-14Node v12+ (at time of writing)typescript@<4
typescript@>=4
Main plugins@oclif/plugin-autocomplete@<1
@oclif/plugin-commands@<2
@oclif/plugin-help@<4
@oclif/plugin-not-found@<2
@oclif/plugin-plugins@<2
@oclif/plugin-update@<2
plugin-warn-if-update-available@<2
plugin-which@<2
@oclif/plugin-autocomplete@>=1
@oclif/plugin-commands@>=2
@oclif/plugin-help@>=4
@oclif/plugin-not-found@>=2
@oclif/plugin-plugins@>=2
@oclif/plugin-update@>=2
@oclif/plugin-warn-if-update-available@>=2
@oclif/plugin-which@>=2

评论 (0)