鎖定專案 Node 版本和包管理器

亖混子發表於2022-05-30
通過文件和溝通約束，遠不如用工具（程式碼）約束。

開發環境

  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） 試試

相關文章