如何发布自己的npm包

1、创建自己的npm账号

注册传送门 注册后注意要验证邮箱,避免发包时提示你需要验证邮箱

2、创建一个简单的npm包

1.在本地创建一个文件夹:如:jiang-model(注意名字应该是npm上没有的,可以在npm上搜索一下看你命的名字是否存在)
2.cd进入该文件夹
3.初始化项目,执行 npm init -y 得到package.json文件

//package.json
{
  "name": "jiang-model",//发布的包名,默认是上级文件夹名。不得与现在npm中的包名重复。包名不能有大写字母/空格/下滑线!
  "version": "1.0.0",//默认版本号
  "description": "",//项目简介
  "main": "index.js",//入口文件,默认是Index.js,可以修改成自己的文件 
  "scripts": { //包含各种脚本执行命令
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",//作者
  "license": "ISC"//开源文件协议
}

4.在文件夹jiang-model中创建名为index.js的文件,如下:

// index.js
const add = function(x,y){
    console.log("两个数相加的方法")
    return x-0+y-0
}
module.exports = {add}

此文件导出了一个名叫add的函数

5.本地测试这个方法是否有效,可以写一个test.js文件(如果觉得不需要测试,则不需要这一步)

在当前目录下运行node test.js 便可以打印出 3,证明方法正确

6.创建README.md文件
该文件名必须为README.md,此文件可以写一些描述自己npm包的说明,便于使用者查看。

3、发布到npm

1.切换下载源 安装 npm install -g nrm

nrm ls //查看当前的下载源,带*指向的就是当前的下载源,如果为npm则不需要切换
nrm use npm //切换到npm的下载源

2.连接npm账户

1)如果是本机第一次发布npm包
在终端中运行命令:npm addUser 提示输入账号,密码和邮箱,然后将提示创建成功,具体如下图:


2)非第一次发布npm包
在终端输入npm login,然后输入你创建的账号和密码,和邮箱,登陆,结果同上。

3.发布npm包

npm publish

发布成功如图:

4.更新npm发布后的包

更新npm包也是使用npm publish命令发布,不过必须更改npm包的版本号,也就是package.json中的version字段,否则会报错,如图:


版本更改
package.json里面有一个version字段,版本格式:主版本号.次版本号.修订号,版本号递增规则如下:
例如:我原本的项目是1.0.0版本的话
主版本号:当你做了不兼容的 API 修改,此情况版本应该为1.0.1
次版本号:当你做了向下兼容的功能性新增,此情况版本应该为1.1.0
修订号:当你做了向下兼容的问题修正。此情况版本应该为2.0.0
通过npm version <update_type>自动改变版本
update_type为patch, minor, major其中之一,分别表示补丁,小改,大改。

5.撤销命令 (一般是慎重撤销)

npm unpublish 包名@版本号 --force
eg:npm unpublish testtoast@1.0.0 --force
说明:撤销发布的包被认为是一种不好的行为,因为如果有团队使用和依赖你的包时,撤销便会造成很大的影响。
1.根据规范,只有在发包的24小时内才允许撤销发布的包
2.即使你撤销了发布的包,发包的时候也不能再和被撤销的包的名称和版本重复了(即不能名称相同,版本相同,因为这两者构成的唯一标识已经被“占用”了)

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,732评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,496评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,264评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,807评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,806评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,675评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,029评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,683评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 41,704评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,666评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,773评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,413评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,016评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,978评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,204评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,083评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,503评论 2 343

推荐阅读更多精彩内容