发布node模块到npm

原文链接 http://blog.gezhiqiang.com/2017/07/26/npm-module
npm(Node Package Manager)是Node.js的包管理工具。npm社区有很多好用的模块。在开发过程中&＃xff0c;我们也会在项目中提炼出一些有用的功能模块。这个时候可以发布到npm并开源到github&＃xff0c;方便别人使用同时又进一步根据issue完善和健壮模块的功能。
下面我就根据自己的一个模块koa2-validation来简单介绍发布 npm 模块的方法步骤以及一些注意点。

创建项目

通常我们的项目要放到github上开源&＃xff0c;便于别的同学提issue。所以可以创建一个github项目&＃xff08;这里默认大家清楚如何使用github&＃xff0c;不明请google&＃xff09;。另外&＃xff0c;默认本机已经安装node和npm&＃xff08;不清楚请参考使用nvm安装node&＃xff09;。

项目结构

github创建项目的时候&＃xff0c;勾选默认的 .gitignore、License 和 README 文件。本地通过npm init 来创建 package.json 文件&＃xff0c;需要数据一些模块的信息&＃xff0c;如名称、版本、描述、作者、license等。

$ npm init

另外&＃xff0c;需要一些 eslint 文件等&＃xff0c;具体的目录结构如下&＃xff1a;

. ├── .eslintrc.json // eslint 文件 ├── .git ├── .gitignore // .gitignore ├── .npmignore // .npmignore 不需要publish的文件 ├── .travis.yml // travis CI ├── LICENSE ├── README.md ├── index.js // 入口文件 ├── lib // 主要逻辑代码 ├── node_modules ├── package-lock.json ├── package.json └── test //测试用例

主要的逻辑代码放在lib目录下。不清楚的同学可以参考koa2-validation的目录结构。

测试

项目通常需要加入必要的单元测试。而且因为可能别的同学会用到&＃xff0c;这一点尤为重要。
关于node的测试&＃xff0c;大家根据自己的习惯会使用mocha、jest等。我个人偏向于使用ava来进行单元测试。不清楚如何使用ava测试的&＃xff0c;可以参考这篇。关于更多测试结构&＃xff0c;参考这里。
关于持续集成&＃xff0c;在github上通常使用 travis 比较多。travis使用起来也很简单方便。首先需要将你的github 账号和travis关联&＃xff0c;travis就会同步你的github repository。然后&＃xff0c;你需要打开对应项目的CI 开关。最后在项目中定义对应的.travis.yml即可在项目push的时候自动运行测试脚本。
更多关于travis的使用可以参考这篇和官方文档.以下是我的.travis.yml 文件。

#指定运行环境 language: node_js #指定nodejs版本&＃xff0c;可以指定多个 node_js:- "7.6.0"before_script:- npm install#运行的脚本命令 script:- npm run test#指定分支&＃xff0c;只有指定的分支提交时才会运行脚本 branches:only:- master

增加徽章

完成功能开发之后&＃xff0c;最好在 README 中详细地介绍模块的使用说明。
另外&＃xff0c;我们经常看到 github 项目有很多漂亮的badge, 例如下载量和测试状况等。那如何添加这些徽章呢。可以参考 shields 和这篇文章。

发布项目

项目完成之后&＃xff0c;我们需要将模块发布到npmjs。通常我们需要先查找一下是否自己的模块已经被注册&＃xff0c;并确定自己的模块名称。
首先&＃xff0c;我们需要到npm官网注册一个账号。然后添加到本地配置。

$ npm adduser Username: dennis.ge Password: **** Email: gedennis&＃64;163.com

然后验证自己的配置。

npm whoami

最后&＃xff0c;在package.json 定义好版本&＃xff0c;通过 npm publish 发布模块即可。

npm publish

npm publish的时候经常会遇到发布不成功的状况。

npm WARN adduser Incorrect username or password npm WARN adduser You can reset your account by visiting: npm WARN adduser npm WARN adduser http://admin.npmjs.org/reset

这个时候通常可能是nvm安装的npm&＃xff0c;或者你的 npm registry 不是npmjs&＃xff0c;通过nrm修改npm源即可。