如何統(tǒng)一前端項(xiàng)目的 Node 版本和包管理器?
開(kāi)發(fā)環(huán)境
- Node.js
- Package Manager (npm、yarn、pnpm)
痛點(diǎn)問(wèn)題
成員機(jī)器 Node.js 版本不統(tǒng)一:守舊派用 12.x、保守用 14.x、激進(jìn)用 17.x。項(xiàng)目能否正常跑起來(lái)全憑天意,在沒(méi)有 CICD 流水線加持本地 npm run build 的場(chǎng)景下線上風(fēng)險(xiǎn)可想而知。
有人習(xí)慣用 npm、有人習(xí)慣用 yarn, 代碼庫(kù)里面經(jīng)常會(huì)存在 package-lock.json、yarn.lock 文件同時(shí)存在的情況。更痛的點(diǎn)還是各種奇奇怪怪問(wèn)題排查起來(lái)沒(méi)有頭緒。
我們要做的就是將問(wèn)題掐死在源頭:鎖定 Node.js 版本和包管理器
鎖定項(xiàng)目 Node 版本
通過(guò)在 package.json 中指定 engines 字段,可限定項(xiàng)目使用的 node 版本。下面配置僅允許用戶使用 14 或者 16的版本。更多的配置可以參考 package.json | npm Docs 、semver
// package.json
"engines": {
"node": "14.x || 16.x"
},
配置之后你會(huì)發(fā)現(xiàn),該字段只對(duì) yarn 生效。那如何對(duì) npm 也生效呢?在項(xiàng)目根目錄下的 ??.npmrc?
? 文件中增加如下配置
// .npmrc
engine-strict = true
以上配置完成后,npm install 試試吧,錯(cuò)誤的 Node.js 將直接退出
鎖定包管理器
利用 only-allow 工具包、npm scripts 快速實(shí)現(xiàn)鎖定。
步驟一:在項(xiàng)目中 ??npm install -D only-allow?
?
步驟二:在 package.json 文件中進(jìn)行配置 ??scripts.preinstall?
? , 允許輸入的值 only-allow npm、only-allow pnpm、only-allow yarn
// package.json
"scripts": {
"preinstall": "only-allow npm",
}
以上配置完成后,可以再亂用 (yarn、npm、pnpm) 試試