介绍
NPM (Node Package Manager, http://npmjs.org ) 是 NodeJS 的模块管理软件,除 NodeJS 内置的核心模块外,其他模块的安装、卸载等管理操作都要通过 NPM 来进行,我们自己写的模块,就要发布到NPM上来供其他人使用。
接下来,我们做一个非常简单的模块 “helloworld”,这个模块的功能只有一个:提供一个参数 “name” ,它在控制台输出 “Hello name”。在开始之前,我们首先要把node和npm装好,安装方法在其项目主页都有介绍,这里就不再多说了。
创建目录helloworld
我们创建一个名为”helloworld”的目录,作为模块的主目录。进入该目录,开始我们的工作。
创建helloworld.js文件,并编写模块的核心代码
创建helloworld.js文件,编写模块的核心代码,很简单,只有以下三行:
<pre>exports.Hello = function ( name ) {
console.log( "Hello " + name );
}</pre>
NodeJS每个扩展模块中都有一个package.json文件,用来描述模块的一些基本属性,比如模块名称、作者、版本号等等。关于package.json写法的详细说明,可以使用 “npm help json” 命令来查看。
创建package.json,主要命令npm init
在模块主目录下执行 npm init 来生成一个最基本的package.json。按照命令的提示依次输入信息即可。以下是在 hello 目录下执行 npm init 并填入相关信息后的结果:
<pre>$ npm init
Package name: (helloworld) //模块名字
Description: A example for write a module //模块说明
Package version: (0.0.0) 0.0.1 //模块版本号
Project homepage: (none) //模块的主页
Project git repository: (none) //模块的git仓库
Author name: //模块作者名字
Author email: (none) //模块作者邮箱
Author url: (none) //模块作者URL
Main module/entry point: (none) helloworld.js //模块的入口文件,我们这里是helloworld.js
Test command: (none) //测试脚本,选填
// 以下是生成的package.json文件内容预览
{
"author":,
"name": "helloworld",
"description": "A example for write a module",
"version": "0.0.1",
"repository": {
"url": ""
},
"main": "helloworld.js",
"engines": {
"node": "*"
},
"dependencies": {},
"devDependencies": {}
}
Is this ok? (yes) //对以上内容确认无误后,就可以直接回车确认了
</pre>
到此为止,我们这个模块就写完了。这时helloworld目录下应该有两个文件:helloworld.js和package.json。
测试
我们可以返回到helloworld的上级目录,来测试安装一下这个模块:
<pre>$ npm install helloworld/
helloworld@0.0.1 ./node_modules/helloworld</pre>
显示安装成功。简单的测试一下:
<pre>$ node
var Hello = require('helloworld').Hello;
Hello('world');
Hello world</pre>
正确输出了”Hello world”。
接下来我们把它发布到NPM上。
用户注册成功
首先,我们需要有一个NPM帐号,可以使用npm adduser来注册一个:
<pre>$ npm adduser
Username: soser
Password:
Email: </pre>
发布,主要命令npm publish
最后回到 helloworld根目录,执行一下npm publish,如果没有任何错误提示,那么就发布成功了。去http://search.npmjs.org/上看一下吧,你的模块应该已经显示在”Latest Updates”一栏里了。
至此,一个NodeJS模块成功发布到NPM,以后就可以在任何能访问npm库的地方通过npm install来安装你的模块了。
删除发布的模块
如何删除呢,执行下面的命令:
<pre>$ npm unpublish helloworld@0.0.1
或者
$ npm unpublish --force helloworld</pre>