使用npm制作nodejs模块包
2014-04-22 22:12
393 查看
NodeJS 是一门年轻的语言,扩展模块并不太全,经常我们想用某个模块但是却找不到合适的。比如前两天我需要使用hmac和sha1来做签名,就没有找到一个比较好用的模块,这时候就需要我们自己来实现相应的功能了。自己写完之后,再把它打包成一个模块分享给大家来用,即方便了其他人,又能让自己有点小小的成就感,实在是一件一举多得的好事情。接下来,我就为大家介绍一下如何封装一个NodeJS模块并把它分享给其他人。
NPM (Node Package Manager, http://npmjs.org ) 是 NodeJS 的模块管理软件,除 NodeJS 内置的核心模块外,其他模块的安装、卸载等管理操作都要通过 NPM 来进行,我们自己写的模块,就要发布到NPM上来供其他人使用。
接下来,我们做一个非常简单的模块 “hello”,这个模块的功能只有一个:提供一个参数 “name” ,它在控制台输出 “Hello name”。在开始之前,我们首先要把node和npm装好,安装方法在其官方网站都有介绍,这里就不再多说了。
首先,我们创建一个名为”hello”的目录,作为模块的主目录。进入该目录,开始我们的工作。
然后,写模块的核心代码,很简单,只有以下三行:
把它保存为 hello.js。
NodeJS每个扩展模块中都有一个package.json文件,用来描述模块的一些基本属性,比如模块名称、作者、版本号等等。关于package.json写法的详细说明,可以使用 “npm help json” 命令来查看。
我们可以在模块主目录下执行 npm init 来生成一个最基本的package.json。按照命令的提示依次输入信息即可。以下是在 hello 目录下执行 npm init 并填入相关信息后的结果:
[plain] view
plaincopy
<span style="color:#333333;">$ npm init
Package name: (hello) //模块名字,npm init会自动取当前目录名作为默认名字,这里不需要改,直接确认即可
Description: A example for write a module //模块说明
Package version: (0.0.0) 0.0.1 //模块版本号,这个大家按自己习惯来定就可以
Project homepage: (none) //模块的主页,如果有的话可以填在这里,也可以不填
Project git repository: (none) //模块的git仓库,选填。npm的用户一般都使用github做为自己的git仓库
Author name: Elmer Zhang //模块作者名字
Author email: (none) freeboy6716@gmail.com //模块作者邮箱
Author url: (none) http://www.elmerzhang.com //模块作者URL
Main module/entry point: (none) hello.js //模块的入口文件,我们这里是hello.js </span><span style="color:#ff6666;">(这个必填)</span><span style="color:#333333;">
Test command: (none) //测试脚本,选填
What versions of node does it run on? (~v0.5.7) * //依赖的node版本号,我们这个脚本可以运行在任何版本的node上,因此填 *
About to write to /home/elmer/hello/package.json
// 以下是生成的package.json文件内容预览
{
"author": "Elmer Zhang <freeboy6716@gmail.com> (http://www.elmerzhang.com)",
"name": "hello",
"description": "A example for write a module",
"version": "0.0.1",
"repository": {
"url": ""
},
"main": "hello.js",
"engines": {
"node": "*"
},
"dependencies": {},
"devDependencies": {}
}
Is this ok? (yes) //对以上内容确认无误后,就可以直接回车确认了</span>
到此为止,我们这个模块就写完了。这时hello目录下应该有两个文件:hello.js和package.json。
我们可以返回到hello的上级目录,来测试安装一下这个模块:
显示安装成功。简单的测试一下:
正确输出了”Hello world”。
接下来我们把它发布到NPM上。
首先,我们需要有一个NPM帐号,可以使用npm adduser来注册一个:
简单三步,一个NPM用户注册成功。
最后回到 hello 根目录,执行一下npm publish,如果没有任何错误提示,那么就发布成功了。去http://search.npmjs.org/上看一下吧,你的模块应该已经显示在”Latest
Updates”一栏里了。
至此,一个NodeJS模块成功发布到NPM,以后就可以在任何能访问npm库的地方通过npm install来安装你的模块了。
NPM (Node Package Manager, http://npmjs.org ) 是 NodeJS 的模块管理软件,除 NodeJS 内置的核心模块外,其他模块的安装、卸载等管理操作都要通过 NPM 来进行,我们自己写的模块,就要发布到NPM上来供其他人使用。
接下来,我们做一个非常简单的模块 “hello”,这个模块的功能只有一个:提供一个参数 “name” ,它在控制台输出 “Hello name”。在开始之前,我们首先要把node和npm装好,安装方法在其官方网站都有介绍,这里就不再多说了。
首先,我们创建一个名为”hello”的目录,作为模块的主目录。进入该目录,开始我们的工作。
然后,写模块的核心代码,很简单,只有以下三行:
exports.Hello = function ( name ) { console.log( "Hello " + name ); }
把它保存为 hello.js。
NodeJS每个扩展模块中都有一个package.json文件,用来描述模块的一些基本属性,比如模块名称、作者、版本号等等。关于package.json写法的详细说明,可以使用 “npm help json” 命令来查看。
我们可以在模块主目录下执行 npm init 来生成一个最基本的package.json。按照命令的提示依次输入信息即可。以下是在 hello 目录下执行 npm init 并填入相关信息后的结果:
[plain] view
plaincopy
<span style="color:#333333;">$ npm init
Package name: (hello) //模块名字,npm init会自动取当前目录名作为默认名字,这里不需要改,直接确认即可
Description: A example for write a module //模块说明
Package version: (0.0.0) 0.0.1 //模块版本号,这个大家按自己习惯来定就可以
Project homepage: (none) //模块的主页,如果有的话可以填在这里,也可以不填
Project git repository: (none) //模块的git仓库,选填。npm的用户一般都使用github做为自己的git仓库
Author name: Elmer Zhang //模块作者名字
Author email: (none) freeboy6716@gmail.com //模块作者邮箱
Author url: (none) http://www.elmerzhang.com //模块作者URL
Main module/entry point: (none) hello.js //模块的入口文件,我们这里是hello.js </span><span style="color:#ff6666;">(这个必填)</span><span style="color:#333333;">
Test command: (none) //测试脚本,选填
What versions of node does it run on? (~v0.5.7) * //依赖的node版本号,我们这个脚本可以运行在任何版本的node上,因此填 *
About to write to /home/elmer/hello/package.json
// 以下是生成的package.json文件内容预览
{
"author": "Elmer Zhang <freeboy6716@gmail.com> (http://www.elmerzhang.com)",
"name": "hello",
"description": "A example for write a module",
"version": "0.0.1",
"repository": {
"url": ""
},
"main": "hello.js",
"engines": {
"node": "*"
},
"dependencies": {},
"devDependencies": {}
}
Is this ok? (yes) //对以上内容确认无误后,就可以直接回车确认了</span>
到此为止,我们这个模块就写完了。这时hello目录下应该有两个文件:hello.js和package.json。
我们可以返回到hello的上级目录,来测试安装一下这个模块:
$ npm install hello/ hello@0.0.1 ./node_modules/hello
显示安装成功。简单的测试一下:
$ node > var Hello = require('hello').Hello; > Hello('world'); Hello world
正确输出了”Hello world”。
接下来我们把它发布到NPM上。
首先,我们需要有一个NPM帐号,可以使用npm adduser来注册一个:
$ npm adduser Username: elmerzhang Password: Email: freeboy6716@gmail.com
简单三步,一个NPM用户注册成功。
最后回到 hello 根目录,执行一下npm publish,如果没有任何错误提示,那么就发布成功了。去http://search.npmjs.org/上看一下吧,你的模块应该已经显示在”Latest
Updates”一栏里了。
至此,一个NodeJS模块成功发布到NPM,以后就可以在任何能访问npm库的地方通过npm install来安装你的模块了。
相关文章推荐
- node.js express 4.x 安装指南(Express不是内部或外部命令解决方案)
- 25行代码等价实现-借助Nodejs在服务端使用jQuery采集17173游戏排行信息
- Leetcode Populating Next Right Pointers in Each Node
- Node on Mac 初步
- DataNode和Namenode无法正常启动
- 【LeetCode】Swap Nodes in Pairs & Reverse Nodes in k-Group
- node-webkit教程(10)Platform Service之File dialogs
- 分享Linode VPS优惠码
- HDU 4587 TWO NODES 删除两个点求连通分量
- Populating Next Right Pointers in Each Node II
- LeetCode: Remove Nth Node From End of List
- window下基于eclipse的Nodejs工程项目配置步骤
- 欲善其功,必先利其器--Nodejs调试技术总结
- Windows环境下的NodeJS+NPM+Bower安装配置步骤
- node.js第十四课(路由控制)
- 【转】Node.js软肋之CPU密集型任务
- 深入浅出NodeJS——数据通信,NET模块运行机制
- window下基于eclipse的Nodejs工程项目配置步骤
- window下基于eclipse的Nodejs工程项目配置步骤
- window下基于eclipse的Nodejs工程项目配置步骤