开发nodejs模块并发布到npm的简单示例

建立一个工作目录!我建立在mrshen/目录下。

新建一个js文件,命名为index.js ,输入如下代码

function hello(name){
  console.log("hello"+ name);
}
exports.hello=hello;

 超级简单!只有一个一个hello函数!

注意: 

exports.hello=hello;  

这句是关键!使用exports将你的hello函数暴漏出去!不懂的可以百度CommonJs规范!

接下来我们在目录里简历一个test.js的文件! 代码如下

 

var  h=require( ' ./index ' );
h.hello( ' Jarrick ');

 可以看到b.js的文件只有两行! 第一行首先使用require('./a')导入刚才的a模块,然后我们调用模块中的hello方法!

一切完毕!虽然两个文件加起来只有5行代码,但是足够我们演示我们所要的了!(有时候简单才让人容易理解)。

让我们用node执行一下,同样很简单,执行代码也只有两句!输出的结果为helloJarrick。

 

 接下来要将我们开发的模块传到npm上了(npm是一个nodejs模块大菜市!)

 我们在cmd中首先进入我们js的工作目录

执行:npm init

会提示你输入name,version,descripttion,等信息,其中name就是你的插件名字,与文件名无关。

该命令可以帮助我们建立一个发布到npm所必须的 package.json 文件,该文件包含了你所建立模块的相关信息,你可以按照它的提示一步步输入即可,最后会在你的目录中发先一个 package.json的文件,我所建立完成之后的内容大概如下

复制代码
{
  "name": "mrshen",
  "version": "1.0.0",
  "description": "test",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "repository": "",
  "keywords": [
    "mcore"
  ],
  "author": "Mrshen",
  "license": "ISC"}
复制代码

如果后续修改要同步,那么版本号version一定要修改,否则不会执行提交。

好了,有了配置之后我们可以将模块发布到npm了!发布前首先使用npm adduser命令增加账户即可!

在文件所在目录打开cmd,输入npm adduser会让你输入你的npm用户名,密码及邮箱

待一切创建成功!

执行npm publish

你就可以到npm你的主页去寻找到你的模块了

我上传之后的页面如下

 

 

使用时,只要在你的命令行中输入 

npm install mrshen

即可安装该模块了!

安装后我们尝试使用一下,在命令行中输入node ,然后用require("mrshen")即可导入该模块!会在屏幕立即显示出helloJarrick的消息!

如果想删除所发布的包,输入npm unpublish 即可,

npm unpublish <package>@<version>可以撤销发布自己发布过的某个版本代码

        npm unpublish 提示拒绝删除
npm unpublish --force 强制删除
npm unpublish 包名 --force 彻底删除包

  • 1
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值