如何解决npm install时package-lock.json内name字段自动增删的git变更问题

问题根因 #

该无意义变更本质是不同npm版本的兼容性差异：

• npm v6及更早版本生成package-lock.json时，不会写入packages[""].name属性
• npm v7及后续版本会自动读取根目录package.json中的name字段，写入packages[""].name属性
  如果团队成员使用的npm版本不一致，每次执行npm install时lock文件就会被对应版本的npm修改该字段，产生无意义的git变更记录。

解决方案 #

• 1. 统一团队npm版本（最根本的解决方法） #

  在项目根目录的package.json中添加engines字段，指定要求的npm版本范围，示例：

  {
    "engines": {
      "npm": ">=8.0.0"
    }
  }
  

  同时在根目录新增.npmrc文件，添加内容engine-strict=true，这样低于指定版本的npm执行安装操作时会直接报错，强制成员使用符合要求的npm版本，避免版本差异导致的lock文件变动。
  也可以搭配nvm等Node版本管理工具，在项目中添加.nvmrc文件指定Node版本，间接对齐对应的npm版本。

• 2. 固定lock文件状态 #

  所有成员统一npm版本后，使用对应版本的npm执行一次npm install，将生成的稳定版本package-lock.json提交到git仓库，之后所有成员执行安装操作都不会再出现该字段的来回变更。

• 3. 统一包管理器 #

  除了npm版本差异外，混用npm、yarn、pnpm等不同包管理器也会导致lock文件结构异常，团队需要明确约定唯一的包管理器，避免跨工具操作产生的无意义变更。

• 临时规避方案 #

  如果暂时无法对齐版本，单次执行npm install后如果仅出现packages[""].name字段的变更，可以直接执行git checkout -- package-lock.json丢弃该部分无意义修改，不要提交这部分变更即可。

内容的提问来源于stack exchange，提问作者Miki