nodejs自己编写发布模块

cdchenli

1 新建模块目录结构
album_mgr
--lib（文件夹）
--test（文件夹）
package.json
Readkme.md
2 编写package.json文件
{
"name": "album-manager",
"version": "1.0.0",
"main": "./lib/albums.js",//设置main启动文件
//"private": true
}
此文件至少要包含一个模块名name和main js文件，以便node可以从此文件加载模块。
如果node找不到package.json文件或没有指定main js文件，它会找index.js或者index.node来完成模块编译。
同时它会告诉npm模块名为album-manager，默认的启动js文件是albums.js其位于lib子目录下。
3 Readme.md(可选）
模块说明文档，github.com使用的标准文件格式。
4 编写核心js文件
  编写albums.js 和 album.js放入lib目录下
  albums.js
var fs = require('fs'),album = require('./album.js');
exports.version = "1.0.0";
exports.albums = function (root, callback) {...};
  album.js
var path = require('path'),fs = require('fs');
function Album(album_path){
this.name = path.basename(album_path);
this.path = album_path;
}
Album.prototype.name = null;
Album.prototype.path = null;
Album.prototype._photos = null;
Album.prototype.photos = function(callback){...};
exports.create_album = function(path){
return new Album(path);
}
5 写个测试用例测下下
test.js
var amgr = require('./album_mgr');
amgr.albums('./',function(err,albums){
if(err){
console.log('unexpected error: ' + JSON.stringify(err));
return;
}
(function iterator(index){
if(index == albums.length){
console.log('Done');
return;
}
albums[index].photos(function(err,photos){
if(err){
console.log('Err loading albums: ' + JSON.stringify(err));
return;
}
console.log(albums[index].name);
console.log(photos);
console.log('');
iterator(index +1);
});
})(0);
})
node node\test.js
结果：
American
[]
China
[ 'CA Technologies.png',
  'Caterpillar.jpg',
  'Charter.jpg',
  'chubb.png',
  'Chunghwa Telecom.jpg',
  'CIFIN.png',
  'Citi.png',
  'CMCC.jpg',
  'Coca Cola.png' ]
Indian
[]
Done
6 本地部署模块
  在package.json中加入"private": true告诉npm暂时还不会将module部署到npm库中。现在我们用npm link告诉npm在本地的默认库中放置一个link连接到album-manager包。
  C:\Users\xxx\node\album_mgr>npm link
C:\Users\xxx\AppData\Roaming\npm\node_modules\album-manager -> C:\Users\xxx\node\album_mgr
7 使用模块
  要使用上面部署的本地模块，还需要做两件事情
  （1）在代码中要引用"album-manager"而不是"album_mgr"，因为npm使用package.json中的name值
  （2）为每个使用模块的project，用npm创建一个到album-manager模块的引用
C:\Users\xxx>mkdir test_project
C:\Users\xxx>cd test_project
C:\Users\xxx\test_project>npm link album-manager
C:\Users\xxx\node_modules\album-manager -> C:\Users\xxx\AppData\Roaming\npm\node_modules\album-manager -> C:\Users\xxx\node\album_mgr
C:\Users\xxx>dir node_modules
Volume in drive C has no label.
Volume Serial Number is 2CCD-F330
Directory of C:\Users\xxx\node_modules
07/07/2014  11:03 AM    <DIR>          .
07/07/2014  11:03 AM    <DIR>          ..
07/07/2014  11:03 AM    <JUNCTION>     album-manager [C:\Users\xxx\AppData\Roaming\npm\node_modules\album-manager]
06/24/2014  03:01 PM    <DIR>          formidable
               0 File(s)              0 bytes
               4 Dir(s)   5,949,730,816 bytes free
8 发布模块
如果我们想把编写的模块共享给其他人，我们可以用npm publish命令将它发布到官方的npm注册，要做的是
（1）移除package.json中private行
（2）用npm adduser在npm注册服务器上创建一个账号
（3）在模块目录中运行npm publish将其push到npm。
C:\Users\xxx>npm adduser
Username: myname
Password:
Email: (this IS public) xxx@163.com
C:\Users\xxx\node\album_mgr>npm publish
+ album-manager@1.0.0
如果我们想从npm注册那里取消发布也很简单
C:\Users\xxx\node\album_mgr>npm unpublish
npm ERR! Refusing to delete entire project.
npm ERR! Run with --force to do this.
npm ERR! npm unpublish <project>[@<version>]
npm ERR! not ok code 0
C:\Users\xxx\node\album_mgr>npm unpublish --force
npm WARN using --force I sure hope you know what you are doing.
- album-manager@1.0.0
用force强制取消发布。