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

Question

当您通过npm分发nodejs命令行应用程序时，人们期望如何组织它？

他们是否期望必须建造它？在本地或全球安装？它应该总是输出bin.js吗？你需要某种别名/脚本来运行它（通过bin.js？）。

Answer 1

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

在本地或全局安装应用程序时，将在路径中（或在node_modules / .bin中本地）创建一个脚本，这将使您的命令行应用程序可以方便地运行。