发布一个npm包,需要几步?

npm(node package management),是nodejs内置的包管理器。中心思想是共享代码,在这里我们可以找到自己需要的包,安装,使用,当然也可以发布我们自己的包。那下面我就来说下,发布一个npm包,需要几步?


发布一个npm包比大象装冰箱麻烦一点点,也就是一点点,不信,你往下看😁:

1、注册npm账号,点我注册
2、登录账号,npm login,根据提示输入用户名和密码
3、赐名,通过 npm info +包名 来查看包信息,包名不能重复
4、初始化包
  a、创建文件夹,mkdir + 包名
  b、进入目录,cd + 包名
  c、初始化包,npm init
  d、按提示输入信息,填充包的详细信息,会生成package.js
  e、编写package.js,根据需要填充目录,安装依赖,编写代码
常见目录结构如下:

index.js代码示例🌰如下

function add (num1, num2) {
    return num1 + num2
}  

function sub (num1, num2) {
    return num1 - num2
} 

module.exports = {
    add,
    sub
};

5、编写好代码,发布, 在项目目录下npm publish即可


注意点:
1、每次发布前,需修改版本号,package.js中的version
2、js包如何兼容ts--------------提供类型声明文件(类型声明文件的主文件名与JS库文件的主文件名相同,后缀为d.ts,例如主文件名为“index.js”,则类型声明文件名为“index.d.ts”)

index.index.d.ts代码示例🌰如下:

export function add(n1: number, n2: number): number;
export function sub(n1: number, n2: number): number;

package.js增加types配置如下:

  "name": "xxxx",
  "version": "我是版本,默认1.0.0,每次发布时需要更新",
  "description": "我是包描述,帮助大家在使用npm search时找到这个包",
  "keywords": ["我是关键字","帮助大家在使用npm search时找到这个包"],
  "main": "index.js", // 我是入口文件
  "types": "index.d.ts", //我是类声明文件
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "dependencies": {},
  "devDependencies": {},
  "author": "",
  "license": "ISC"

3、删包
  a、删除某个版本: npm unpublish 包名@版本号
  b、删除整个包:npm unpublish 包名 --force

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

推荐阅读更多精彩内容