npm入门(二)—package(包)的管理
前言
上一篇 npm入门(一)—了解基本组成与概念 简单介绍了一下npm的相关知识,这篇可以说是npm的核心知识。
分类
关于pacakge,是有分为public pacakge(公共包)、private pacakge(私有包)。前面我们也知道npm账号也有两种,一直的免费使用者,一个是付费使用者。私有包是付费使用者才能释出的。
直观地,在npn website上看,package前面会有个标签标注该包是公有的还是私有的
scopes
在此之前,我们先了解这么一个概念——scopes(中文意思是作用域)。我们在注册npm账号和建立组织时,你将被授予一个与你的使用者或组织名称匹配的范围,即你获得了一个适用范围(scope),这个范围是你的使用者名称或者建立的组织名。你可以将此范围用作相关包的名称空间。如你有一个package名叫mypackage,你的使用者名称为myusername,则你可以把这个package放到你的域里
@myusername/mypackage
这样有什么作用呢?
避免与别人的包重名,发生冲突。限制该包的访问许可权。假设你是付费使用者,想要建立一个私有包,那么可以在你的域里授权哪些使用者才能访问public package
预设地,如果我们不对registry进行了任何设定,那么释出的包就是基于预设的registry(http://registry.npmjs.org)的,释出出来的包是公共的,任何人都可以访问使用。
public package也有两种:
unscoped package:这个就是普通的共用包了,没有指定范围scoped package:这个是在划分了范围的包,预设是私有的,但是手动转化为共有的。private package
私有包,只有付费使用者才能建立。私有包,是指只有授权使用者才能进行下载释出等管理,而且还能指定各种许可权,例如只读只写之类的。
私有包肯定是指定了范围的(scoped),预设地,指定了范围的包都是私有包(当然后面可以手动更改)
私有包可以划分两种
使用者范围的私有包:只能由你和你授予读或读/写访问许可权的协作者访问。org(组织)范围的私有包:只能被授予读或读/写访问许可权的团队访问。包型别的转换
上面我们知道包的一些分类,那么,如何在需要时改变它们的型别呢?
公有转私有
在npm website上操作的方法就不说了,直接说敲命令的方式:
npm access restricted
替换为真实包名
私有转公有
在npm website上操作的方法就不说了,直接说敲命令的方式:
npm access public
替换为真实包名
需要注意的是,只有是付费使用者才能转为私有。
私有包授权使用者
私有包有时候为了协作,需要新增其他开发者进行一起管理,所以需要把私有包授权给某些使用者。根据私有包型别
使用者私有包
在npm website上操作的方法就不说了,直接说敲命令的方式:
npm owner add
组织私有包
要授予npm使用者对私有组织包的访问权,您必须有一个组织所有者将它们新增到您的组织中,然后将它们新增到有权访问私有包的团队中。具体步骤参考 这里
建立package
说了那么多,是时候应该知道,如何建立一个package了。
进入你想要建立package的资料夹根目录中,执行以下命令
npm init
进行npm专案(package)的初始化,当执行这个命令后,会出现一个问卷,例如问你专案的名称,作者,描述等资讯,你按照实际情况输入回应即可。填完问卷后,会在该目录下生成一个package.json档案,该档案里包含刚回应问卷的一些资讯。
如果你懒得一个个回应,可以使用预设的情况,执行
npm init --y 或者 npm init --yes
这样会自动根据你当前目录的情况,生成一系列预设资讯在package.json档案。
当然我们也可以设定一些init时的固定指定资讯,如
npm set init.author.name xxxx
npm set init.author.email xxxx
这里就设定了init时固定作者资讯是啥
如果你想建立的是指定域的包,那么执行
npm init [email protected]
yourscopename替换成你想要起的域的名称
package.json
上一篇我们说过,package是由一个package.json档案描述组织起来的,所以这个档案至关重要。先大概看一下这个档案长哪样
{
"name": "xxxx",
"version": "1.0.0",
"description": "xxx",
"author": "myname ",
"private": true,
"scripts": {
"dev": "concurrently "webpack-dev-server --inline --progress --config build/webpack.dev.conf.js --env.sysName=eod" "node mock-server.js""
},
"dependencies": {
"vue-router": "3.0.1"
},
"devDependencies": {
"autoprefixer": "7.1.2"
},
...
}
挑了些常用常见的内容展示出来。
属性描述name必需。package的名称version必需。package的版本,遵循semantic versioning spec(语义版本控制规范)description推荐。用来描述你的package的一些资讯,方便别人在npm website上查询你的pacakgeauthor作者的相关资讯。格式Your Name (http://example.com)。包含了你的名称、邮箱和部落格之类的网址,不一定要全写private你的package是私有的还是公有的scripts一些npm指令码,形成npm指令,方便你进行某些工作,如构建dependencies这是你的package释出后,罗列的所需要依赖的一些别人的package,缺乏了这些package,你的package也会不能如期正常工作devDependencies这里是罗列你在开发过程中所依赖的一些package,为了方便你的开发所用的包,缺少他们也不会影响到你的包释出后的正常使用,就放在这里了。
作用
从档案里能看出,该包的一些基础资讯,以及所依赖的一些包能看出所依赖的包的一些版本资讯使你的构建具有可重复性,因此更容易与其他开发人员共享README.md
顾名思义,这个相当于用该package之前先看它的意思,即使用手册之类的意思。一般地,推荐package包含这个档案比较好,方便使用者使用你的包。这个档案是使用markdown语法
此档案只有在释出包的新版本时才会在包页面上更新。
释出package
释出package之前,要好好检查你的档案里是否包含某些私人资讯,敏感资讯。请注意删除或者释出时忽略掉。使用.npmignore或.gitignore档案来忽略掉,详情见 此
释出包命令:
npm publish
如果要释出一个未指定域的公用包,直接执行上述命令即可。如果要释出一个指定域的私有包,直接执行上述命令即可(预设指定域是私有包)。需要注意的是,publish之前要注意npm所在registry,如你要释出到公司的registry里,则释出前需要切换到公司registry下,才执行该命令,例如使用上一篇提到的npmrc工具如果要释出一个指定域的私有包进行公有化,执行npm publish --access public
pacakge的版本控制规范
一个package一定要指定某个版本,而为了规范网络上大家各种各样的package,方便大家交流共享等,就制定了一个版本控制规范,大家在给自己package指定版本/更新版本的时候就好好考虑版本号了。
以当前版本为1.0.0为例子,遵循以下规范:
更新情况位置version修复当前版本的一些bug第三位1.0.1新增向后相容的新特性第二位1.1.0进行了破坏性地无法向后相容的更改第一位2.0.0
在package.json里,我们看到依赖项里,包的版本资讯里会出现^~符号。这里要知道这些符号代表什么意思。例如
"eslint": "^3.19.0",
"css-loader": "~3.19.0",
代表安装这个包的版本资讯是浮动的,而不是指定死版本。
^代表固定主版本号的,其余号浮动,如^1.3.0,高于等于1.3.0,1.x.x都符合,但是要低于2.0.0~代表固定次版本号的,修订号浮动,如~1.3.0,高于等于1.3.0,1.3.x都符合,但是要低于1.4.0为package打tag
虽然package已经有版本号作为一些资讯反馈给使用者,但是语义化不够,不够直观明了,因此可以为package加上tag,即标签,为其备注一些资讯,让使用者更浅显易懂点。如执行
npm publish --tag beta
在释出时,就为package打上了beta标签了。
预设地,释出时会自动继承这个包上次释出的标签的资讯,如上次打了个beta标签,后面直接执行npm publish时,也会自动应用上beta标签。
需要注意的是,tag名尽量不要使用数字或者v(不论大小写)开头的名字,因为tag的名称空间和版本号是一起的,会发生冲突。
如果想要指定版本进行打标签,执行
npm dist-tag add @ tagname
如
npm dist-tag add [email protected] beta
释出后对于package的管理
更新版本
当你在维护一个包时,免不得了在调整之后需要对版本进行改变,以告知使用你的包的人,执行以下命令进行更新版本并进行释出
npm version
npm publish
弃用与取消弃用package
弃用
当你不再想维护一个package,你需要告知那些依赖了你的包的人,让他们知道你的这个包你不再进行维护了,这是出于你的责任心啦。执行
npm deprecate 'message'
这里的message就是你需要告知别人你的一些关于弃用的讯息,这里一定要带上这个讯息哦,不然就是另一个含义了。
如果你只想弃用某个版本,而不是整个package,执行
npm deprecate @ 'message'
注意:弃用之后别人在npm的网站上会搜不出你的包来哦。访问你的包的网页也会有标识表名你的包给弃用了。别人在安装你的包时也会出现弃用的讯息
取消弃用
如果日后你又回心转意了,想继续维护这个包,那么你就可以取消弃用了。执行
npm deprecate ''
大家留意到吗,这里跟弃用的命令很像,唯一的区别在于,之前的message替换成'',这样就可以取消弃用了
转移package
如果你不想维护你的包了,你可以选择弃用,也可以选择转移你的包,希望它再找个主人吧。你可以把你的包转移给@npm,执行
npm owner add npm
npm owner rm
上面的两句命令就是,为你的package新增授权给npm,然后删除你对该包的拥有权。为你的账号名
所以,当转移了包之后,你就没了对它的使用权了,也不能更新它。
取消释出
释出了一个包之后,如果日后你不想让它再出现了,又不想仅是标志弃用,那么可以选择取消这个包的释出。当然这个行为可能会对别人产生不好的影响,例如别人依赖你的包,你无声无息地把这个包给取消掉了,叫别人情何以堪。
当你释出了一个公共package之后,72小时内后悔了,可以执行
npm unpublish -f
如果你仅想取消某个版本,执行
npm publish @
如果是72小时后,那么需要联络 npm support了。如果你想取消的是一个组织包,非个人包,那么需要联络 [email protected]
安装package
我们已经了解过了pacakge的基本情况,知道从他的建立到释出,到释出后的管理。都是从自身作为包的拥有者角度去处理包,那么现在是时候作为一名使用者角度,知道如何使用别人的包了。
使用别人的包,首先就得安装下载他们的包,安装分为两类:
local install (本地安装)global install (全域性安装)本地安装
例如在你的某个专案中,需要使用到别人的一些包,那么需要在你这个专案下下载安装所需的包,下载下来的包只会在该专案中被引用。
换个思路去理解,就是像很久以前开发一个专案,需要引入某个类库,如jquery,那么就下载jquery.min.js,放在专案里某个资料夹里,然后在适当的位置引入它来进行使用,如在index.html里通过script标签进行引用。这样的话,其实这个jquery.min.js只会在这个专案里被引入使用,而不能在第二个专案B中被引用,因为它是被放在专案A里面了,这种就是本地安装
执行以下命令进行本地安装:
npm install
会依据专案中的package.json档案的依赖项以及宣告的semver规则的最新版本来进行安装对应的包。如果该专案里没有node_modules资料夹,那么会新建一个,里面内容就是安装的package程式码,如果有,那么直接在这个资料夹下新增pacakge
如果想要安装指定某个包(私有包请带上@域名/),执行
npm install
如果专案里没有package.json档案,那么会下载指定包的最新版本,如果存在,会下载package.json中宣告的semver规则的最新版本。
如果想要指定依赖的型别(dependencies, devDependencies等)
npm install --save
加上--save是指该package是生产依赖项,存放在package.json的dependencies里,其实这是个预设的行为,即就算不加上--save,预设也是放在dependencies里。
如果想放在开发依赖里,执行
npm install --save-dev
如果想要安装指定版本或者tag的包,执行
npm install @
npm install
需要注意的是,如果是指定了某个tag的package进行安装,那么下载安装如果不带上tag,会自动预设依据上次的tag资讯进行安装,例如,
npm install loadash beta
下次安装loadash的时候,预设是下载beta标签的loadash
全域性安装
全域性安装,就是指安装一些共用的包,在你的本地计算机下的专案,都能共用这些包。例如npm了,每个专案都需要使用npm,那么全域性安装就好了,不必要每个专案都独立安装一遍。指令也很简单
npm install -g
npm install -g
其实跟本地安装介绍的意思是一样的,只不过区别就在于,多了个-g来标记是全域性安装
更新package
随着时间的变化,可能你本地下载的包已经是比较老的了,需要更新一下别人的包,那么在专案根目录下执行
npm update
即可更新package.json里罗列的包。
如果想单独更新某个包(私有包请带上@域名/),执行
npm update
同样地,如果想更新全域性的包,也是加个-g即可,如
npm update -g
如果想看看当前专案里有哪些过时的包,可以执行
npm outdated
会显示当前有哪些包过时了。当然这也可以用来检验是否更新成功了
如果想看看有哪些过时的全域性包,执行
npm outdated -g --depth=0
取消安装/删除package
如果某个包你不想要了,为了节省空间以及协作时避免别人下载一些不必要的资源,可以删除某些不需要的包。执行(私有包请带上@域名/)
npm uninstall
指定删除某个包
npm uninstall -g
指定删除某个全域性包
结语
未经授权请勿复制文章发文!
也可关注K前端微信公众号检视哦!