2016-08-24 56 views
-1

當您通過npm分發nodejs命令行應用程序時,人們希望如何組織nodejs命令行應用程序?分發nodejs命令行應用程序的最佳實踐

他們是否期望構建它?在本地或全球安裝它?它應該總是輸出一個bin.js?你需要一些別名/腳本來運行它(通過bin.js?)。

+0

在人們希望能夠安裝它的最常見方式之前編寫(和使用過)命令行應用程序是通過'npm install -g'完成的。你只需要在'package.json'中指定'bin'部分。無需手動輸出bin.js文件。 – slebetman

+0

此外,爲了避免這個問題被關閉,你應該從「什麼是最好的方式......」改爲「我該怎麼做......」。現在它的措辭的方式意味着你正在尋找民意調查 - 這是強烈不鼓勵SO。提出問題很好,要求意見不好。 – slebetman

+0

我想了解行業慣例,不僅僅是「一種方式」,也不是某人最喜歡的方式 –

回答

1
  • 使用package.json中的bin字段指定CLI的入口點javascript文件。
  • #!/usr/bin/env node添加到入口點js文件的頂部。
  • 指定哪些需要與你的應用程序被打包的文件,使用的package.json
  • 在自述的files領域,提供消費者可以用它來安裝你的應用的npm install命令行,例如,它可以在點一個github存儲庫或一個上傳到npm註冊表的軟件包,您可以使用npm pack創建該軟件包。

在本地或全局安裝應用程序後,腳本將在路徑中創建(或在本地node_modules/.bin中),這將使您的命令行應用程序可以方便地運行。