如何统一前端项目的 Node 版本和包管理器？

Posted 2022-06-08 SHERlocked93

通过文档和沟通约束，远不如用工具（代码）约束。

作者：亖混子

原文：https://segmentfault.com/a/1190000041918155

开发环境

1. Node.js

2. Package Manager （npm、yarn、pnpm）

痛点问题

成员机器 Node.js 版本不统一：守旧派用 12.x、保守用 14.x、激进用 17.x。项目能否正常跑起来全凭天意，在没有 CICD 流水线加持本地 npm run build 的场景下线上风险可想而知。

有人习惯用 npm、有人习惯用 yarn, 代码库里面经常会存在 package-lock.json、yarn.lock 文件同时存在的情况。更痛的点还是各种奇奇怪怪问题排查起来没有头绪。

我们要做的就是将问题掐死在源头：锁定 Node.js 版本和包管理器

锁定项目 Node 版本

通过在 package.json 中指定 engines 字段，可限定项目使用的 node 版本。下面配置仅允许用户使用 14 或者 16的版本。更多的配置可以参考  package.json | npm Docs 、semver

// package.json 
  "engines": 
    "node": "14.x || 16.x"
  ,

配置之后你会发现，该字段只对 yarn 生效。那如何对 npm 也生效呢？在项目根目录下的 .npmrc 文件中增加如下配置

// .npmrc
engine-strict = true

以上配置完成后，npm install 试试吧，错误的 Node.js 将直接退出

锁定包管理器

利用 only-allow 工具包、npm scripts 快速实现锁定。

步骤一：在项目中 npm install -D only-allow

步骤二：在 package.json 文件中进行配置 scripts.preinstall ， 允许输入的值 only-allow npm、only-allow pnpm、only-allow yarn

// package.json
"scripts": 
    "preinstall": "only-allow npm",
    ...

以上配置完成后，可以再乱用 （yarn、npm、pnpm） 试试

最后

如果你觉得这篇内容对你挺有启发，我想邀请你帮我个小忙：

1. 点个「喜欢」或「在看」，让更多的人也能看到这篇内容

2. 我组建了个氛围非常好的前端群，里面有很多前端小伙伴，欢迎加我微信「sherlocked_93」拉你加群，一起交流和学习

3. 关注公众号「前端下午茶」，持续为你推送精选好文，也可以加我为好友，随时聊骚。

点个喜欢支持我吧，在看就更好了

开发者涨薪指南 48位大咖的思考法则、工作方式、逻辑体系