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

开发 前端
通过文档和沟通约束,远不如用工具(代码)约束。我们要做的就是将问题掐死在源头:锁定 Node.js 版本和包管理器。

开发环境

  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) 试试

责任编辑:庞桂玉 来源: 如何统一前端项目的 Node
相关推荐

2022-02-28 10:22:08

前端管理工具

2022-02-21 09:58:31

包管理器npmyarn

2021-11-11 11:13:20

js Npm基础

2018-10-15 15:00:42

UnixSysget包管理器

2021-07-27 12:58:46

Linux包管理器安命令

2020-03-09 11:43:35

RustCargo编程语言

2020-12-03 12:06:54

HarmonyOS

2021-12-09 09:27:22

MacOSHomebrew包管理器

2022-10-11 16:09:27

系统Linux管理器

2023-04-12 00:00:40

Node.jsMonoreponpm

2010-10-08 09:26:17

.NET微软

2023-04-17 07:36:28

Arch LinuxGUI

2024-11-12 08:03:27

JavaScript管理器安全

2010-01-06 16:33:24

Ubuntu软件包

2018-08-23 16:51:40

Linux软件仓库包管理器

2023-03-15 08:00:00

Node软件包管理器开发

2023-12-06 10:18:35

Python开发

2016-09-12 15:00:46

Linux包管理器新手

2010-05-27 10:12:46

openSUSEYaST

2022-03-21 21:28:00

Homebrew包管理器Linux
点赞
收藏

51CTO技术栈公众号