npm项目脚手架

辅助在Github上从零快速开始一个公开的npm项目, 内置以下功能:

• 源代码可以使用ES2017，npm publish时通过babel编译为ES2015, 最低支持node.js v6.0.0
• 代码提交前自动运行npm run lint, 基于ESLint + Airbnb JavaScript Style Guide, 不规范的代码将无法提交
• 基于AVA实现单元测试
• 基于TravisCI进行持续集成
• CI通过后基于Codecov自动生成代码覆盖率报告
• 通过Github的release功能, 自动打包发布到npm

使用方法

1. 在Github建立一个空repository, 如myproject, 并clone到本地

cd myproject && wget https://github.com/lonly197/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注册邮箱， NPM api key等信息

其中NPM api key可运行npm login登录npm后, 在~/.npmrc中找到形如

//registry.npmjs.org/:_authToken=XXX

其中XXX部分就是api key

4. 修改package.json内项目信息, push代码到Github

5. 通过git tag -a和git push --tags添加一个tag，或者直接使用Github的release功能，完成一次发布