npm项目脚手架
在Github上从零快速开始一个公开的npm项目, 内置以下功能:
- 源代码可以使用ES2017,
npm publish
时通过babel编译为ES2015, 最低支持node.js v6.0.0 - 代码提交前自动运行
npm run lint
, 基于ESLint + Airbnb JavaScript Style Guide, 不规范的代码将无法提交 - 基于AVA实现单元测试
- 基于TravisCI进行持续集成
- 通过Github的一个release, 自动打包发布到npm
- CI通过后基于Codecov自动生成代码覆盖率报告
使用方法
1. 在Github建立一个空repository, 如myproject
, 并clone到本地
cd myproject && wget https://github.com/bmqb/npm-project-template/archive/master.tar.gz -O master.tar.gz && tar xvf master.tar.gz --strip 1 && rm master.tar.gz
2. 在TravisCI网站中点击"Add New Repository", 找到对应github项目并开启
3. 实现TravisCI完成后发布到npm
安装travis ci命令行
gem install travis
运行travis setup npm
, 根据提示完成配置
npm login
在~/.npmrc
中找到形如
//registry.npmjs.org/:_authToken=XXX
travis encrypt "XXX" --add
3. 修改package.json
内项目信息, push代码到Github