Node.js相对路径依赖模块中peerDependencies配置问题

我有一个遵循AWS指南的lib包，其依赖配置如下：

"devDependencies": {
    "aws-cdk-lib": "2.1.0"
  },
"peerDependencies": {
    "aws-cdk-lib": "^2.1.0"
  },

该lib包与我的app包并行检出，app包通过相对路径依赖它：

"dependencies": {
    "lib": "../../lib",
    "aws-cdk-lib": "2.39.0"
  },

当前行为 #

• 在lib目录执行npm install
• 在app目录执行npm install后，node_modules中会创建指向lib的符号链接，使用aws-cdk-lib@2.1.0版本

期望行为 #

• 在lib目录执行npm install
• 在app目录执行npm install时，复制lib的源码到node_modules并构建，使用aws-cdk-lib@2.39.0版本

我不想使用git仓库依赖这类替代方案，因为部署时获取git凭证较为麻烦。

方法1：用npm pack生成本地tar包依赖 #

这是最贴合npm包安装逻辑的方式，能让lib像普通npm包一样被安装，自动适配app的依赖版本：

1. 在lib目录执行：

   npm pack
   

   执行后会生成一个类似lib-1.0.0.tgz的压缩包（版本号由lib的package.json决定）
2. 修改app的package.json，把相对路径依赖替换为本地tar包路径：

   "dependencies": {
       "lib": "../../lib/lib-1.0.0.tgz",
       "aws-cdk-lib": "2.39.0"
     },
   

3. 在app目录执行npm install，此时npm会将tar包解压到node_modules，并自动使用app的aws-cdk-lib@2.39.0版本（符合lib的peerDependencies版本范围要求）

如果需要频繁更新lib，可以写个脚本自动化流程：
在lib的package.json中添加：

"scripts": {
    "pack-local": "npm pack && cp lib-*.tgz ../app/lib-local.tgz"
}

然后app的依赖改为：

"dependencies": {
    "lib": "./lib-local.tgz",
    "aws-cdk-lib": "2.39.0"
}

每次更新lib后，执行npm run pack-local，再在app里执行npm install lib即可同步最新代码。

方法2：用文件复制脚本配合npm钩子 #

如果不想用tar包，可通过脚本手动复制源码并构建：

1. 在app的package.json中添加预处理脚本（注意根据操作系统调整命令，以下为Linux/macOS版本）：

   "scripts": {
       "preinstall": "rm -rf node_modules/lib && cp -r ../../lib node_modules/lib && cd node_modules/lib && npm install --production"
     }
   

   Windows环境可替换为：

   "scripts": {
       "preinstall": "rmdir /s /q node_modules\\lib && xcopy /e /i ..\\..\\lib node_modules\\lib && cd node_modules\\lib && npm install --production"
     }
   

   该脚本会在npm install前清空旧的lib目录、复制最新源码、并在目标目录安装生产依赖，同时利用peer依赖机制使用app的aws-cdk-lib版本。

关键注意事项 #

• 必须保留lib的aws-cdk-lib在peerDependencies中，不能放到dependencies，否则会强制使用lib指定的版本。
• 确保lib的peerDependencies版本范围^2.1.0包含app使用的2.39.0，避免npm版本兼容报错。

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