Press "Enter" to skip to content

Yakima Teng | 滕运锋

浅谈项目中node和依赖的node包的版本管理

这是最近才注意的一个问题。之前在上一家公司的时候,有个项目组的项目,经常发生有的人的电脑里安装项目依赖后无法启动项目的问题,然后每每都是让他从别的同事那里把node_modules文件夹打包拷贝过来,我刚去那个项目组的时候也碰到了这个问题,也是从别的同事那里拷贝了一份node_modules文件夹才能正常跑项目的,后来经过尝试发现好像如果我将npm命令的版本降低到2+再安装项目依赖的话就能正常跑了,但是这个显然是个很奇葩的现象,另外需要说的是他们那个项目也有package-lock.json这个文件的,这个项目因为不是一开始就在跟的项目,我也搞不拎清究竟是哪里出了问题。但是node包的版本管理依旧很重要,不管理的话更容易发生类似这样的问题。

一、不要直接修改package-lock.json/yarn.lock文件

如果要增删项目的依赖或者修改其版本号,不要手动直接去修改package-lock.json/yarn.lock文件,而要通过对应的npm命令或yarn命令进行操作:

1、通过npm增删包

2、通过yarn增删包

通过这些命令去更新项目依赖信息的同事,不仅会自动更新package.json文件,还会同步更新package-lock.json文件(如果用的是npm)或yarn.lock文件(如果用的是yarn)。而且这里有个特点,通过这种方式更新的package.json文件里的项目依赖都是将依赖包按包名字母顺序排列的,这样比较好找包的版本信息。如果你打开一个项目的package.json文件发现里面的包名排列没有顺序乱七八糟的,那就说明这个人是直接自己手改。

二、指定node包到具体的小版本号

因为:

1、你不能信任第三方包都完全按照语义化版本号规则去更新版本号;

2、你不能信任按语义化版本号更新版本号的第三方包在修复bug或添加新功能时不会引入新的bug;

3、第三方包在更新版本号的时候可能会更新它对应的依赖包的版本号,第三方包依赖的第三方包的版本号变动又可能引发上面的问题。

三、不要在同一个项目里同时混用npm和yarn

假设你通过 npm i -S a 命令添加并安装了node包a,并且实际安装的版本是1.0.1,这时候具体的版本信息是记录在package-lock.json文件里的,过了一个月另外一个同事通过 yarn install 命令安装包a时,由于具体的版本信息在yarn.lock问及那种是不存在的,所以完全有可能这位同事实际安装的是1.1.2版本,这样就会造成包的版本管理混乱的问题,反过来也是一样,不再赘述。

四、团队开发时应当同统一node版本号

团队合作开发的项目中,大家各自电脑里的node版本号也需要进行统一,如果不统一,比如甲本地 node --version 为9.2.1,乙本地使用 node --version 为10.0.0,那么可能会有两种问题:

1、如果一个程序的版本遵循语义化版本的规定,那么a.b.c这样的版本号中,a的变动表示的是较大的版本升级(可能会有不向前兼容的新API等)b的变动表示的是较小的、向前兼容的功能更新,c的变动表示的是一些bug修复。但是我们不能保证第三方程序都严格按照这个语义化版本的规定进行版本号的命令,另外也无法确定只是更新了版本号的c部分的是否只是修复了已知bug而没有再次引入新的bug,所以我个人是建议直接把node版本号进行统一,而不是给出一个允许使用的node版本号区间

2、这里还有一个问题,比如乙在本地添加了一个依赖包,该依赖包要求node版本号10.0.0及以上,由于乙本地node版本号为10.0.0所以可以正常安装该依赖了,但是甲本地的node版本号为9.2.1,就无法安装该依赖包了,团队合作开发的项目,我们当然是希望大家都可以在本地正常安装项目依赖并运行项目的。

如果你本地有多个项目分别要求不同的node版本的话,可以使用nvm这个命令行工具。nvm的安装及使用都是非常简单的。

另外需要加一句:推荐使用标记为LTS的版本,这种版本官方会用较长的时间进行维护,所谓LTS,就是Long-Term-Support长期支持的意思。

五、强制约束node版本和使用npm还是yarn来进行依赖管理

我们当然可以只通过文件和口头约定的方式来约束大家都使用相同版本的node,并约束大家都使用npm或者yarn其中一种(不可混用)来进行依赖包的管理,但是在书面/口头约定之外,在代码上再进行一下限制会更稳妥一些。下面是我从vue2官方webpack模版的源码里抄过来并按自己的需求修改了一下的两段代码。

限制使用的node和yarn的版本:check-version.js:

不允许使用npm进行依赖管理(原理是检测项目根目录下是否存在运行npm install时生成的package-lock.json文件,npm-shrinkwrap.json是作向前兼容的,不是很):check-npm.js:

跟check-version.js对应的,需要在package.json文件里添加类似下面这样的代码(这里我认为yarn的版本可以需用限定的太死所以只是限定了一个区间,之所以要求小于2是因为从1都2属于大的版本更新了,现在yarn还没有出2版本,谁知道到时候对应的命令是否还能使用):

check-version.js和check-npm.js两个文件的使用方法很简单,在平时开发和打包命令对应的文件的开头,添加类似下面的代码即可(注意导入后的代码后面需要加一个括号去执行它,因为上面两个文件导出的都是函数):