第23章 常见问题 FAQ
FAQs 常见问题
为什么选择 Node? Node 是编写 CLI 代码的最佳选择,原因如下: 在 Salesforce,我们曾用 Ruby、Go 和 Node 开发过 Heroku CLI。如果想了解这段历史,可以阅读那篇文章。最终我们发现,Node 综合表现最佳。 首先,JavaScript 是世界上最流行的编程语言。使用 JavaScript 的开发者人数远超其他语言,其开源社区也遥遥领先。由于人人皆可编写,你能找到大量实用库来辅助构建 CLI。 其次,我们发现 Node 在所有我们使用过的语言中,跨平台支持最好。通常,在 macOS 上写的代码,很少会在 Windows 上遇到问题。 Node 对插件模型的支持也最为出色。插件是一种在 CLI 间共享代码、模块化 CLI 代码库,并允许用户为现有 CLI 添加功能的方式。使用 Node,不同的依赖版本可以并排存在。因此,如果你更新某个插件的依赖,不会影响其他插件的运行。oclif 甚至将这一点做到极致,连 flag 解析都是在单个插件层面进行的。例如,如果我们未来想要对 flag 解析进行破坏性变更(别担心,我们没这个打算!),你只需更新其中一个插件,而其他插件仍可保持旧行为。对于大型 CLI 代码库,这一特性在缓慢迁移到新代码时非常有用。
如何像 Go 那样创建单二进制 CLI? 使用 pkg。记得在 package.json 中设置 pkg.scripts: "./lib//*.js",以包含命令及其他源文件。 不过,在 Salesforce CLI 中,我们更倾向于分发包含内置 Node 的 tarball 及各类安装程序。使用 oclif pack 可以为不同平台生成内置 Node 的 tarball 集合。你的 CLI 中最好使用 @oclif/plugin-update,否则用户无法在不重新安装的情况下从 tarball 更新 CLI。
应该使用 TypeScript 还是 JavaScript? 我们建议使用 TypeScript,因为在重构代码和更新依赖时,类型检查非常有帮助。比起在生产环境中发现错误,不如在编译阶段就捕获错误。 我们在让 TypeScript CLI 的创建变得简单方面投入了大量精力,即使你从未写过 TypeScript 也没关系。我们生成的 CLI 和插件使用 ts-node,这意味着无需编译步骤即可快速运行 TypeScript 代码。使用 oclif 时,你也不需要麻烦地去配置构建工具。 当然,目前这两种语言非常相似。你在 JavaScript 中写的代码与 TypeScript 中的几乎一样,只是没有类型定义而已。
哪个编辑器最适合 oclif? 如果你已有喜欢的编辑器,请继续使用。不过,我们通常推荐 Visual Studio Code(简称 VS Code)。 Microsoft 在这个编辑器上做得非常出色,它在 TypeScript 项目上的表现尤为出色。开箱即用地提供优秀的类型检查、代码检查和自动补全功能。
应该使用 npm 还是 yarn? 差别不大。如果你是初学者,保持简单,使用随 Node 附带的 npm。我们内部喜欢使用 yarn,因为它稍快一些,且 lockfile 用起来更友好。
如何让 oclif 生成器运行得更快? 如果你在使用 npx,先运行 npm install -g oclif 全局安装 oclif。但为了获取生成器的最新版本,你必须手动运行 npm update -g oclif。
为什么不支持 Node X? oclif 项目遵循并支持 Node 的 LTS(长期支持)时间表,这使 oclif 能够与 Node 的开发保持同步。
"oclif" 怎么发音? 我们读作 "oh-cliff"。