分发 nodejs 命令行应用程序的最佳实践

Best practice for distributing a nodejs command line application

当您通过 npm 分发 nodejs 命令行应用程序时,人们会如何组织它?

他们会期望必须建造它吗?本地安装还是全局安装?它应该总是输出 bin.js 吗?您是否需要某种别名/脚本来 运行 它(通过 bin.js?)。

  • 使用 package.json 中的 bin 字段为您的 CLI 指定入口点 javascript 文件。
  • #!/usr/bin/env node 添加到入口点 js 文件的顶部。
  • 使用package.json
  • files字段指定需要与您的应用打包的文件
  • 在 README 中,提供一个 npm install 命令行,消费者可以使用它来安装您的应用程序,例如它可以指向一个 github 存储库,或者一个上传到 npm 注册表的包,您可以使用 npm pack.
  • 创建

在本地或全局安装应用程序后,将在路径中(或本地在 node_modules/.bin 中)创建一个脚本,这将使您的命令行应用程序 运行 方便。