如何从我发布的 npm 包中运行 shell 脚本

Question

我意识到这是一个愚蠢的问题，但我很好奇我是如何完成以下任务的。

我为我在学校的同学创建了一个 shell 脚本，用于构建大型项目模板。我已经成功将包发布到npm，但是下载后无法让脚本运行。我希望用户只需下载软件包并运行 $ npm project-template start（作为示例）之类的东西来触发脚本。

这可能吗？

如果有人有意见、建议、指点，我将不胜感激。提前致谢！

Answer 1

总是在我在网上询问答案后，我自己才能找到答案。

将程序添加到binaries 对象

基本上，我需要做的是将要运行的命令添加到package.json 的bin 部分：

"bin": {
  "nameOfCommand": "path/to/script.sh"
}

左侧nameOfCommand 是终端中使用的命令的名称

$ nameOfCommand args --options

右侧是 CLI 程序的路径，在本例中是 bash/shell 脚本。

The information can be found here 在 NPM 的这篇文章中。