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

Question

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

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

Answer 1

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

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