NPM创建自己的包及注意事项

当自己造了个小轮子希望在npm包里跑起来,怎么操作呢?总结了一下流程,和遇到的问题及解决方法,以下操作基于Mac环境。

一、准备事项

1、保证本地全局安装了nodejs环境
$ node --version
v11.0.0

如上示例,能返回node版本就表示已经安装了,如果没有,请移步Nodejs官网安装。

2、在npm上发布包,必须得有账号

前往npm注册一个账号。

二、开始

1、登录
$ npm login
Username: xiaohua
Password:
Email: (this IS public) xiaohua@outlook.com

如上,在iTerm2中输入命令npm login,然后就会让你输入用户名密码和一个公开的邮箱,按照之前在npm中注册的信息填写就行。

2、创建demo

$ mkdir xiaohua && cd xiaohua
$ npm init

这里注意,虽然是demo,但也要用npm init,不要用快速默认的命令npm init -y,会漏掉keywords,github等信息,如果用了npm init -y,也要记得在项目的package.json中把相关信息补全。

$ touch index.js

创建一个index.js文件,然后写上简单的一些内容就行。

// index.js
const myname = "xiaohua";
module.exports = myname;
3、发布

准备就绪后,就可以执行npm publish + 包名称进行发布了,是不是很简单,对!就是这么简单。

$ npm publish xiaohua
success.png

如上,没有任何ERROR就发布成功了,然后去npm上搜索xiaohua,如下,可以看到已经有了:

npm.png

三、注意事项

总结了下面几种发布失败的情况和注意事项,供大家参考

1、包名重复错误
npm ERR! code E403
npm ERR! 403 Forbidden - PUT http://registry.npmjs.org/koa - You do not have permission to publish "koa". Are you logged in as the correct user?

如上,我发布一个名为koa的包,报错,很显然koa包已存在。

切记发布前先去npm上搜一下自己的包名,看是否有重复,如果遇到上面提示,修改下包名,再去npm搜一下,确保没有这个包之后,再发布。

2、npm仓库镜像错误
npm ERR! code E403
npm ERR! 403 Forbidden - PUT https://registry.npm.taobao.org/pengxiaohua - [no_perms] Private mode enable, only admin can publish this module

可以看到错误提示中https://registry.npm.taobao.org这个是淘宝的仓库镜像,而不是npm的仓库镜像,需要更换成npm仓库镜像。发布前可以先查看本地默认仓库镜像,如下:

$ npm config get registry
> http://registry.npmjs.org/

如果npm config get registry后,返回的http://registry.npmjs.org/, 则说明的对的,如果返回如下:

$ npm config get registry
> https://registry.npm.taobao.org/

这是淘宝镜像,说明之前可能是安装过cnpm,设置了本地的默认仓库镜像是淘宝的。需要修改本地仓库镜像,如下操作:

$ npm config set registry=http://registry.npmjs.org

再次执行npm login,然后执行npm publish XXX发布包。

如果发布成功后,则再次将仓库地址设为淘宝镜像地址,方便本地cnpm的使用。

$ npm config set registry=https://registry.npm.taobao.org/
3、包版本号version错误
npm ERR! code E400
npm ERR! 400 Bad Request - PUT http://registry.npmjs.org/xiaohua - Cannot publish over previously published version "1.0.0".

遇到这个问题,修改package.json中version版本号,避免和上一次发布重复,再次发布就可以了。

4、撤回发布的包

npm包24小时内可以强制撤回,超过24小时的就不行了。

$ npm --force unpublish xiaohua

如果发布同一个包1次以上(即多个版本)了,那么就只能通过npm deprecate去废弃包,如下操作:

$ npm deprecate xiaohua@1.0.1 "sorry, it's a my test npm package, I love Xiaxia && Ruoyu"

使用npm deprecate时,最后的message一定要带上,否则执行失败。

5、更新发布包

如果对已创建的包要更新,更新后上传要修改项目的版本号,即package.jsonversion,也可以在项目目录下执行npm version patch

这是我发布的npm包get-image-size,根据图片的链接获取图片的文件大小,欢迎大家在github上star和提issue。

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

推荐阅读更多精彩内容