手把手带你发npm包

引言:

前端微服务的流行趋势,为了能做到独立开发、独立部署,不同微服务(子项目)公用组件的使用使npm包变得不可或缺


重要概念 scope:

包的范围(作用域)

包的范围,访问级别和可见性


准备工作:

1.npm注册账号

2.如果是发布组织范围的包,需要先创建一个组织

3.仓库地址为npm,如是cnpm,用nrm切换

npm i nrm -g(安装)

nrm ls(查看仓库地址)

nrm use npm(切换)


发布包:

一.发布一个没有作用域(unscoped)的公共包

1.在命令行上,为包创建一个目录:

    mkdir my-test-package

2.导航到包的根目录:

    cd my-test-package

3.如果您使用git来管理软件包代码,请在软件包根目录中运行以下命令,替换git-remote-url为软件包的git远程URL:

    git init 

    git remote add origin git://git-remote-url

4.在程序包根目录中,运行该npm init命令,生成package.json文件

5.创建一个README文件(必须)说明您的包代码是什么以及如何使用它,和.npmignore或.gitignore文件(非必须)来阻止发布到注册表

6.编写包的代码

7.发布:在根目录输入

    npm publish

登录:由于没有登录npm,发布的时候肯定会报错,输入 npm adduser,然后根据提示输入用户名、密码和邮箱,登录之后重新发布就行了。

二.发布一个有作用域(scope)的公共包

如果您使用npmrc 管理多个注册表上的帐户,请在命令行上切换到相应的配置文件:

npmrc <profile-name>

1.在命令行上,为包创建一个目录:

    mkdir my-test-package

2.导航到包的根目录:

    cd my-test-package

3.如果您使用git来管理软件包代码,请在软件包根目录中运行以下命令,替换git-remote-url为软件包的git远程URL:

    git init

    git remote add origin git://git-remote-url

4.在程序包根目录中,运行npm init命令并将作用域传递给scope标志:

    对于组织范围的包,请替换my-org为组织的名称:

    npm init --scope=@my-org

    对于用户范围的包,请替换my-username为您的用户名:

    npm init --scope=@my-username

5.创建一个README文件(必须)说明您的包代码是什么以及如何使用它,和.npmignore或.gitignore文件(非必须)来阻止发布到注册表

6.编写包的代码

7.发布:在根目录输入

    npm publish --access public(之后的版本迭代可使用npm publish)

三.发布一个私有包

步骤和 二.发布一个有作用域(scope)的公共包 一样,但是第7是用npm publish发布。

注意:在发布私有用户范围的npm包之前,您必须注册一个付费的npm用户帐户。此外,要发布私有组织范围的包,您必须创建一个npm用户帐户,然后 创建一个付费的npm组织


安装包:

npm官网找包,然后npm-i-packageName


更新包:

更改包内容重新发布,必须要改动其version,再npm publish。

可以在package.json里直接改动version,也可以使用变更版本号的命令:npm version <major | minor | patch>

npm采用语义化版本,共三位,以’.’隔开,从左至右依次代表:主版本(major)、次要版本(minor)、补丁版本(patch)。

例如:1.0.0=》major.minor.patch


弃用包:

如果您不再希望维护包,或者您希望鼓励用户更新到新版本或不同版本,则可以弃用它。

弃用整个包:

    npm deprecate <package-name> "<message>"

弃用单个版本的包:

    npm deprecate <package-name>@<version> "<message>"


删除包(unpublish):

为了从npm注册表中永久删除包(或包版本),作为包所有者或协作者,您可以在初始发布后的72小时内从命令行取消发布它。

删除整个包:

    npm unpublish <package-name> -f

删除单个版本的包:

   npm unpublish <package-name>@<version>

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

推荐阅读更多精彩内容

  • npm是什么 NPM的全称是Node Package Manager,是随同NodeJS一起安装的包管理和分发工具...
    build1024阅读 7,851评论 0 9
  • 本文参考:【原】npm 常用命令详解从0开始发布一个无依赖、高质量的npm包Yarn 官网 上一篇文章 npm总结...
    双面小Q阅读 2,198评论 0 6
  • NPM官方文档写的十分良心,此篇我做一些比较常用功能的积累,有些地方是翻译,有些地方省略可以去官文看。 NPM是什...
    宋乐怡阅读 2,389评论 0 2
  • 1 从前有个大侠。 大侠在成名前是个和尚。 那个年头佛教兴盛,成为和尚的渠道很多,有诚心皈依的,也有杀了人后遁入空...
    林陌鹿阅读 1,756评论 23 32
  • 日子紧挨着土地匍匐前进 照样有人在针尖上烹茶煮酒 阳光照在山巅上折射出海市蜃楼 一段梦于枕畔辜负了谁 地狱和天堂如...
    陌上冷阅读 205评论 0 0