我應該如何組織一個JS開源庫項目？

Question

我維護一個JS前端庫。

要開始我寫在Rails中，因爲這就是我所知道的。如果你安裝了Rails，它工作的很好，但這對於其他人來說是一個非常愚蠢的方式。

什麼是「最佳實踐」方式來組織在Github上用CoffeeScript編寫的前端JS庫？

需要有簡單的方法來

1. 構建從一組的CoffeeScript文件壓縮編譯發佈版本。

2. 在開發期間運行在瀏覽器新版本

3. 運行一個測試套件

Answer 1

我不知道我的建議是否會回答你的問題或沒有。

我的建議是

1. 使用依賴管理工具，例如，NPM或涼亭管理第三方的lib
2. 使用的構建工具，例如，咕嚕或吞下或的WebPack建立你packange包括縮小，得到唯一需要的文件，編譯咖啡的js
3. 使用摩卡或其他測試框架運行測試

然後整合上面CI工具的任務，例如，詹金斯將其自動化

你詹金斯的工作將逐步完成這些任務步驟

1. 拉代碼從GitHub汽車
2. 清潔您的回購，例如，git的復位 - 硬& & git的清潔-xdf
3. NPM安裝或者涼亭安裝
4. 運行的WebPack或咕嚕吞下或
5. 運行測試

Answer 2

我的建議是用一個目錄結構像這樣的發佈爲NPM模塊：

package.json 
.gitignore (include lib and dist) 
.npmignore (include test) 
webpack.config.js 
src/ 
    index.coffee 
    (other sources) 
lib/ (generated by npm script) 
    index.js (compiled) 
dist/ (optional - for browser bundle) 
    bundle.js 

的的WebPack/DIST支持是可選的，但會方便誰想要使用的庫沒有的WebPack任何用戶或者瀏覽。