我应该如何组织JS开源库项目？

Question

我维护了一个JS前端库。

为了开始，我在Rails中写了它，因为这就是我所知道的。如果安装了Rails，它的效果会非常好，但对于其他人来说，这是一种非常愚蠢的方式。

在Github上组织用CoffeeScript编写的前端JS库有什么“最佳实践”方法？

需要有简单的方法

1. 从一组CoffeeScript文件构建压缩编译版本。

2. 在开发期间在浏览器中运行新版本

3. 运行测试套件

Answer 1

我不确定我的建议是否会回答你的问题。

我的建议是

1. 使用依赖管理工具，例如，npm或bower来管理第三方lib
2. 使用构建工具，例如grunt或gulp或webpack来构建你的包装，包括minify，只获取所需文件，将咖啡编译成js
3. 使用mocha或其他测试框架来运行测试

然后将上面的任务集成到ci工具，例如jenkins以自动化它们

你的jenkins工作将逐步完成这些任务

1. 从github auto拉取代码
2. 清理您的仓库，例如，git reset --hard＆amp;＆amp; git clean -xdf
3. npm install或bower install
4. 运行webpack或grunt或gulp
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或browserify的情况下使用库的用户来说都很方便。