Express 系列:结合实例讲解如何开发一个自己的npm包

作为一个依赖Nodejs作为全栈开发基础的同学，如果要让他们说出关于代码世界最爱不释手的部分，相信绝大部分同学都会谈到npm，是的，这是一个十分活跃的代码包管理工具，它有自己的官方网站，集中着近300000的功能各异的包，很多都是代码品质优良，又有大神精心维护的精品。同时，也允许程序员发布属于自己的包，参与开源活动。

在我们学习Nodejs的过程中，相信有无数次的冲动和欲望想要自己实现一个属于自己的npm包，完全切合自己的需求，本节就来带领大家一起开发一个独属于各位自己的npm包，并且发布出去。

1.npm包结构：

以下对目录结构做一些介绍：

• 目录：

lib：存放项目源代码

node_modules：存放项目依赖文件

test：存放测试代码

doc：对于一些大型包项目，须有配套文档

• 文件：

package.json：npm init 命令生成，包括一些包的基本信息

index.js：通用的包项目主入口文件

README.md：包描述文件

• 其他还可能出现文件：

- .npmignore记录哪些文件不需要被发布到npmjs.org

- .travis.yml是持续集成服务travis的描述文件

- makefile方便我们用make test进行测试

- .gitignore

2.主入口文件编写

介绍了包的主要目录结构之后，我们来编写自己包的主入口文件，也就是index.js文件。

先给出我们的代码：

module.exports = require('./lib');

代码详解：通常为了项目的可扩展性,我们会把所有实现代码放在 lib 文件夹内,这样一来 index.js 就可以只作为一个入口文件存在，这里引入这个模块的主程序模块。

3.lib源码目录中默认index.js的编写：

先给出我们的代码：

module.exports = {

index: function() {

return 'hello';

},

add: function(a, b) {

return a + b;

}

}

代码详解：

在CommonJS的模块系统中, module.exports 可以输出一个函数,也可以输出一个对象。所以我们可以这样编写 lib 中的 index.js，来实现两个函数。

4.关于package.json文件

这里我们给出我们的项目生成的package.json文件：

{

"name": "npm-package-hello",

"version": "0.0.1",

"description": "first npm package commit",

"main": "index.js",

"directories": {

"doc": "doc",

"test": "test"

},

"scripts": {

"test": "echo \"Error: no test specified\" && exit 1"

},

"keywords": [

"npm",

"package",

"hello"

],

"author": "lj",

"license": "MIT",

"devDependencies": {

"chai": "^3.5.0",

"mocha": "^2.5.3"

}

}

5.如何在代码中应用自己的包

核心命令：

npm link

对于Noder开发npm包来说，这应该算是最有价值的命令。假设我们开发了一个模块叫 npm-package-hello ，然后我们在 project 里引用这个模块 ，每次 npm-package-hello 模块的变动我们都需要反映到 project 模块里。有了 npm link 命令,这一切变得易如反掌。

具体流程：

cd ~/npm-package-hello # 进入npm-package-hello 模块目录

npm link # 创建链接到/usr/local/lib/node_modules

接下来我们需要把 npm-package-hello 引用到 project项目中来：

cd ~/project # 进入project模块目录

npm link npm-package-hello # 把全局模式的模块链接到本地

npm link npm-package-hello 命令会去 /usr/local/lib/node_modules 目录下查找名叫 npm-package-hello 的模块，找到这个模块后把 /usr/local/lib/node_modules/npm-package-hello 的目录链接到 ~/project/node_modules/test 这个目录上来。

现在任何 npm-package-hello 模块上的改动都会直接映射到 project 上来。

npm link 对于开发时一个模块被多个模块引用时非常有用。

6.编写单元测试

引入的测试包和断言库：Mocha（类似的还有Jasmine、Karma、Tape）， Chai（类似行为驱动开发(BDD)的还有，Should.js,Expect.js）

测试的文件都部署在test文件夹下面，默认文件名test.js

首先我们需要全局（方便在命令行使用）安装Mocha：

npm install mocha --save-dev -g

接着安装Chai（选择它的理由是它结合了Should的，Expect的，还独有自己的断言）

npm install chai --save-dev

然后编写我们自己的test.js测试文件用来测试lib/index.js文件中的代码：

var assert = require('assert');

var hello = require('npm-package-hello');

describe('hello npm test', function() {

it('should print sth', function(done) {

assert.equal(hello.index(), 'hello');

done();

});

it('should add sth', function(done) {

if (hello.add(3, 6) !== 9) {

throw new Error('add failed');

}

done();

});

});

在终端中输入mocha,会自动运行 test 目录下的 test.js 文件.

结果如下显示：

7.发布自己的包

首先添加npmjs的用户：

//提示输入用户名，密码，邮箱

$npm adduser

成功之后，npm会把认证信息存储在~/.npmrc中，并且可以通过以下命令查看npm当前使用的用户：

$ npm whoami

$ npm publish --tag 0.1.0

版本格式：主版号.次版号.修订号，版号递增规则如下：

主版号：当你做了不相容的 API 修改，

次版号：当你做了向下相容的功能性新增，

修订号：当你做了向下相容的问题修正。

先行版号及版本编译资讯可以加到「主版号.次版号.修订号」的后面，作为延伸。

8.如何持续管理自己发布的npm包：

所有发布在NPM上的模块,都可以在自己的NPM主页上看到。 但是如果想要更为直观的管理,可以通过一个名为badgeboard的工具来浏览。

对于NPM的模块,已经有很多成熟的服务,方便开发者了解自己的模块状态。 正如上图中所示,常用的服务有:

持续集成:travis

测试覆盖:coveralls

查看模块依赖:david-dm

下节介绍

Intro

学习了怎样开发自己的npm模块，是不是还感觉意犹未尽呢呀？Nodejs当然不止这样，作为一项革新了前段工程化进程的创举，还会被用来开发一些命令行工具，下一节，我们就来一起开发一个属于我们自己的命令行工具。