10-发布模块
[toc]
3.3.4 发布模块
开发了npm的朋友也为我们提供了一个关于如何发布Node模块的文档:开发者指引。
这份文档说明了package.json的一些额外的字段。除了我们已经创建的字段外,还需要加入一个内容为目录的directories字段,比如我们前面用到的test目录和doc目录:
"directories" : {
"doc" : ".",
"test" : "test",
"example" : "examples"
}
发布之前,开发者文档建议我们要提前测试模块是否能正确安装。要测试这项功能,需要模块目录中输入下面的命令:
npm install . -g
此时,我们已经测试了inputChecker模块,向package.json中加入了directories字段,并且确定模块可以正常安装。
下面,我们需要将自己的信息加入到npm的用户信息中去。输入下面的命令:
npm adduser
运行命令之后我们需要输入一个用户名、密码和Email。最后还需要执行以下命令:
npm publish
我们可以提供打包文件的位置或者整个目录。文档警告过我们,除非使用一个包含package.json所有文件的.npmignore文件来忽略源代码,否则目录中的所有内容都会被加入到模块中。当然,最好在发布之前把不需要的文件都删除。
一旦模块被发布——而且代码被上传到了GitHub(如果你用了GitHub作为代码库的话)——这个模块就算是正式发布了。你可以在Twitter、Google+、Facebook以及你的网站上,或者任何你觉得人们想要看到这个模块的地方,去推广这个模块。这种推广可不是炫耀——这是分享。