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

第7章 oclif 更新:支持生成更友好的 CLI 错误信息

Pretty Printable Errors 2020年7月1日 · 阅读时长一分钟 命令行界面(CLI)常被用作便捷工具,因此当出现问题时,提供更多上下文信息会很有帮助。oclif 新增了几个属性,以便在显示错误时向用户展示额外的上下文。如果代码中包含这些属性,它们将会被展示出来,包括 code、ref 和 suggestions。要在现有的 oclif CLI 中实现此功能,只需在 CLI 的 package.json 依赖项中添加最新的 @oclif/errors 和 @oclif/core 即可。 例如,使用带有额外属性的 this.error: class TestError extends Command {
async run() {
this.error("An error has occurred!", {
code: "OCLIF_ERR",
ref: "https://oclif.io/docs/commands#thiserrormessage-string--error-options-code-string-exit-number",
suggestions: ["Use these extra properties to provide additional context"],
})
}
}
这将产生以下输出: › Error: An error has occurred!
› Code: OCLIF_ERR
› Try this: Use these extra properties to provide additional context
› Reference: https://oclif.io/docs/commands#thiserrormessage-string--error-options-code-string-exit-number
如果未提供这些属性,则不会有任何改变,CLI 将继续像之前一样显示单条错误信息。此外,作为此次改进的一部分,我们增加了关于 oclif 错误处理的文档,如果需要扩展 oclif 的默认错误处理机制,这些文档将非常有帮助。

评论 (0)