手把手教你发布自己的NPM包

前言

当你在完成一个个工程项目时,忽然发现需要某个需求实现工具,恰好此时你发现npm或者git上还没有这样的工具,或者没有完全满足你要求的工具。
是时候展现真正的技术了,你可以自己实现它,并且发布到npm上,作为一个轮子供其他人使用,这将是一件令程序员兴奋的事。
在你发布的npm包右侧可以看到每天的下载量。这在你的简历里也是一个亮点。
下面,我将手把手教你发布自己的NPM包!

1.注册NPM 账号

注册地址:www.npmjs.com/

2.初始化自己要发布的项目

搭建本地环境:安装node.js,包含了npm命令。 新建目录,在该目录下,初始化项目:npm init。 按照提示填写初始化信息,我的模块名称为:node-cpdir,初始版本号:v1.0.0。 模块名称需遵循相关政策要求:www.npmjs.com/policies , 不能够与已有NPM模块名冲突等等。

{
  "name": "node-cpdir",
  "version": "1.0.0",
  "description": "A tool to copy a directory to another.",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": ["copydir", "copydir", "moveDir"],
  "author": "Young",
  "license": "ISC"
}
  • name 你的模块名, 需要保证唯一,npm仓库上的模块名是不能重复的
  • main描述了当你用require('modulename')引用这个模块的时候,引用的是哪个文件,这个字段的值你可以采用默认的或者修改成你项目中任何一个有效的文件
  • keywords为别人搜索到你的包的关键字
  • author就是你了,但是如果你的项目不是你一个人来发的,那么你也应该将你的开发伙伴一起添加进去

3.登录npm,发布自己的npm包。

npm login

根据提示输入之前注册的账号、密码。 发布npm包到公共平台:

npm publish --access=public

此时在自己个人的npm账号主页可以看到该包。

4.使用自己发布的包(模块)的示例代码:

安装之前发布的npm包:

npm install node-cpdir

5.更新自己的NPM包(模块)及 readme文件

修改代码和readme.md后,执行命令:

npm version patch
npm publish

npm version后面参数说明:

patch:小变动,比如修复bug等,版本号变动 v1.0.0->v1.0.1

minor:增加新功能,不影响现有功能,版本号变动 v1.0.0->v1.1.0

major:破坏模块对向后的兼容性,版本号变动 v1.0.0->v2.0.0

6.发包常见错误:

  • 处于错误的npm源:
    npm ERR! 403 Forbidden - PUT http://registry.npm.pt.mi.com/copydir - no_perms
    此时需要使用nrm切换到正确的官方npm源npm -------- https://registry.npmjs.org/
  • 未登录或切换源后未重新登录
    npm ERR! 401 Unauthorized - PUT https://registry.npmjs.org/cpdir - You must be logged in to publish packages.
    需要重新npm login
  • 包名重复
    npm ERR! 403 Forbidden - PUT https://registry.npmjs.org/cpdir - You do not have permission to publish "cpdir". Are you logged in as the correct user?
    需要重命名你的package.json中的name。即使你在npm官网没有搜到你预设的包名,它可能也被发布占用过,需要重新考虑。
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,015评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,262评论 1 292
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,727评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,986评论 0 205
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,363评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,610评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,871评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,582评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,297评论 1 242
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,551评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,053评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,385评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,035评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,079评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,841评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,648评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,550评论 2 270

推荐阅读更多精彩内容