luckyjing / package

a simple npm package boilerplate for creating your own module

Scaffold out a node module with ES6+, Babel, ava and npm scripts,inspired by rise and dva

安装

$ git clone https://github.com/luckyjing/package <your_project_name>

// 安装依赖
$ npm install

// 执行test目录下的所有测试用例，并且呈现测试覆盖率报告
$ npm run test

// 模块ES6转换为ES5
$ npm run build

// [todo] 产生公共资源（如*.min.js）
$ npm run dist

发布

推荐使用git-extras来代替手动的执行npm publish命令，它有这些优点：

• 将从上一次的release版本到本次提交之间的所有提交生成一个changelog，非常便捷
• git release 1.x.x便自动完成push，tag,npm publish，修改package.json等一系列操作。

// 发布流程
$ git changelog
$ git release 1.x.x

功能

• 支持Babel，所有的ES6语法模块转换为ES5模块后进行发布
• 使用ava作为测试框架，完美支持ES6,语法更简洁
• 集成travis-ci，可以自动生成测试覆盖率报告（需要手动在travis-ci和coveralls里进行关联本次仓库）参考文章

License

MIT