如何发布一个npm包

最近写了一个非常简单的头像生成器脚本,给定用户名或者任何字符串,给定大小,就会生成字符串的第一个字符作为图片主体的头像。支持Unicode编码字符。支持转成stream,支持转成buffer

Demo.

从0到发布到npm仓库需要踩才哪些坑呢?

将npm的registry设置为官方源

如果你不是淘宝npm镜像的用户,即可跳过这一步。

在国内,因为某些不可抗力。使用npm来安装node模块是非常慢的。所以大部分npm用户都使用了cnpm和淘宝的npm镜像,cnpm每10分钟和上游的npm同步。

但是如果想要发布npm包,就不能发布到cnpm了,就要将安装cnpm时候的设置的registry设置回官方的。

$ npm config set registry https://registry.npm.taobao.org

注册npm账号

将registry设置回npm官方源之后就可以注册账号了,如果你注册了就可以直接登录,npm login 或者 npm addUser

第一次执行npm addUser会在npm注册一个账号。

完成后就自动登录了。登录了npm账号才可以发布包。

npm包结构

.
├── README.md
├── example
├── lib
├── node_modules
├── package.json
├── index.js
└── test

对于一个npm包来说,package json是必须的。具体的package json内容可以自己执行npm init生成一个package json来查看。

但是有几点是必须注意的。

  • author这一项必须与当前的npm用户相同,否则是没有权限发布的。
  • main指定了包的入口。如果没有指定就默认为根目录的index.js
  • name作为你的包的名字,千万注意不要和npm上已有的包重名,npm不允许同名的包存在。所以发布如果报错
npm ERR publish 403
You do not have permission to publish 'somepackage'.Are you logged in as
the corrent user?:somepackage

最好先去npmjs.org查看你的包名是否已经被别人使用过了,或者运行npm search xxx来搜索。

发布

写好代码,index.js导出模块。

$ npm publish

就可以发布了

更新

更新package.json中的版本号,再次运行

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

推荐阅读更多精彩内容

  • npm是什么 NPM的全称是Node Package Manager,是随同NodeJS一起安装的包管理和分发工具...
    build1024阅读 7,870评论 0 9
  • 大家好,我是IT修真院深圳分院第3期的学员,一枚正直纯洁善良的前端程序员,今天给大家分享一下,修真院官网前端工程师...
    大大头大阅读 2,951评论 0 1
  • 什么是 NPM npm之于Node,就像pip之于Python,gem之于Ruby,composer之于PHP。 ...
    ihoey阅读 6,249评论 2 36
  • 烦躁 剪不断,理还乱 别是一番滋味在心头 火大 楚山经月火 忽惊屋里琴书冷 窝心 假如感情能够解释 这不是随便传说...
    爱上一叶浮萍阅读 360评论 12 14
  • 【日精进打卡第14天】 《六项精进》 大纲,背诵3遍,共57遍 《 大学》诵读2遍,共42遍 其他经典,无 日行一...
    a92bbf37be2b阅读 153评论 0 0