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

第11章 oclif 2024 春季更新:改进 @oclif/core 并支持 ESM

# 第11章 oclif 2024 春季更新 2024年3月29日 · 阅读4分钟 各位 oclif 开发者大家好!距离上一篇博客已经有一段时间了——这期间发生了很多事情。 过去几年,我们主要聚焦在以下几个方向: - 改进 @oclif/core - 支持 ESM - 改进并焕新 oclif.io - 重新活跃 oclif 社区

改进 @oclif/core

自三年前发布 @oclif/core 以来,我们已经推出了两个新的主版本,每个版本都带来了不少令人兴奋的特性。 以下是一些主要变化: - 完整支持 ESM,并能与 CommonJS 互操作(下文详述)。 - 可配置的命令发现策略,让你能更灵活地控制命令在运行时如何加载。详见文档。 - 新增 preparse 钩子,可以在参数被解析之前先做处理。Salesforce 就用它实现了一个很巧妙的 --flags-dir 功能,可以把本地文件转换成 flag。 - 新增 Performance 类,可用于追踪 @oclif/core 以及你自己的 CLI 或插件内部的性能。详见文档。 - 新增 flag 类型 Flags.option,支持为 flag 定义一组预设选项,TypeScript 会根据这些选项自动推断 flag 的类型。 - flag 现在支持 relationship 属性,可以定义 flag 之间更复杂的关系。更多信息请看 flags 文档。 - flag 现在支持 defaultHelp 属性,可以在命令帮助中设置更易读的默认值。当 flag 的 parse 方法返回复杂类型(比如对象或类)时,这个属性特别有用。更多信息请看 flags 文档。 - 命令现在支持 hiddenAliases 属性,可以定义对用户隐藏的别名。当你想让用户逐步弃用某个旧命令时,这个属性非常好用。 - 现在可以用 bun 或 tsx 作为开发运行时(不再局限于 node 或 ts-node)。 - 当用户漏填必需的 arg 或 flag,或者输入了不存在的 flag 时,现在会同时展示命令的用法、args 和 flags。 如果你需要帮助迁移到最新版本,请查看 core 的 README,里面有各版本迁移指南的链接。如果需要我们或社区更具体的帮助,也欢迎发起新的讨论。

ESM 支持

@oclif/core 第3版完整支持开发 ESM 插件和 CLI,同时也完整支持 CommonJS 与 ESM 插件之间的互操作。 简单来说,你现在可以把 CLI 迁移到 ESM,同时让部分插件继续留在 CommonJS(反过来也可以)。升级路径因此变得简单得多。你也不用再担心社区插件的情况——不管它们是已经先迁移到了 ESM(比如所有 @oclif 官方插件),还是短期内坚定留在 CommonJS,都不影响你。 更多内容请看这里。

改进并焕新 oclif.io

我们另一个重点是改进文档站 oclif.io。 在提升文档质量和准确性的同时,我们还升级到了最新版的 docusaurus。新版本让网站焕然一新,还带来了暗色模式、公告栏等很实用的新功能。 如果有任何反馈或遇到问题,欢迎告诉我们,直接在 oclif.io 仓库提 issue 即可。

重新活跃 oclif 社区

最后,也是我们当前最重要的目标:重新活跃 oclif 社区。我们知道,多年来大家的 issue 和 pull request 得不到回应,一定很让人沮丧。为之前没有优先照顾社区,我们深表歉意,并会切实确保今后每一个 issue 和 pull request 都能得到应有的关注。 我们还为 @oclif/core 和 oclif CLI 开放了 GitHub discussions,你可以在那里提问或分享想法。希望大家多多使用,我们很乐意听到你的声音! 最后透露一点:我们打算公开我们的 roadmap,让你更清楚地了解我们正在做什么。敬请期待! 祝好, oclif 团队

评论 (0)