乐趣区

关于node.js:锁定项目-Node-版本和包管理器

通过文档和沟通束缚,远不如用工具(代码)束缚。

开发环境

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

退出移动版