如何在Node项目中引用和发布自己写的Module

Every file in Node.js is a module。                      -----《Learning Node 2nd 》

引用:

首先在编写模块时尽量按照如下文件结构规范,非强制:

+ModuleName/

       +lib/

               .js文件

       package.json文件


如果你已经写好了自己的Node模块,想在其它工程中调用该模块,方法如下:

一、更改package.json文件内容,新增"private":true键值对,更改结果:


name表示模块名称,在其它项目中引用该项目时使用的是该名称,而并非模块存储位置的文件夹名称,为了统一、直观、避免错误个人建议这里的name的值同模块所处的文件夹名称保持一致

version表示模块的版本号,当然自己写的可以随意指定,但为了规范与后期考虑,建议规范书写

main表示调用该模块时程序的主入口.js文件

private为true用于告知npm不能发布该模块

二、进入模块文件夹使用npm link命令

在/usr/local/lib/node_modules/album-manager文件下会发现多一个链接型文件,如果不想使用直接将该文件删除即可。

三、进入其它想引用该模块的工程文件夹内使用npm link ModuleName命令


命令成功后会发现在node_modules子文件夹下多了一个album-manager的链接文件,添加成功。这样做的好处就是当需要对自己的模块更改时,其它工程对该模块的引用时也会发生改变。


发布:

如果想共享自己写的模块给网上其它人员使用,可以使用 npm publish命令将自己的模块发布到官方的npm 模块库中,步骤如下:

一、首先删除package.json文件中的"private":true键值对

二、进入模块文件夹内添加自己的npm帐号

Test$ npm  adduser

Username:输入用户名(小写)

Password:输入密码

Email:输入邮箱地址

成功创建账户后,依然在当前目录中执行如下命令发布:

Test$ npm  publish

如果想撤销自己的发布使用npm  unpublish  --force命令强制删除自己发布的模块即可









相关推荐
©️2020 CSDN 皮肤主题: 大白 设计师:CSDN官方博客 返回首页