npm monorepo项目如何实现安装tgz包时拉取所有子项目package.json的依赖

npm/yarn/pnpm等包管理器默认安装tgz格式的依赖包时，仅会读取包根目录下的package.json声明的依赖，不会主动遍历子目录的package.json，可通过以下几种方案实现全量依赖安装：

方案1：配置monorepo workspaces（推荐） #

这是目前多包项目的标准实现方案，适配所有支持workspace特性的包管理器版本（npm 7+、yarn 1+、全版本pnpm）：

• 在根目录package.json中添加workspaces字段，声明所有子项目的路径：

{
  "name": "你的根包名称",
  "version": "1.0.0",
  "workspaces": [
    "project1",
    "project2",
    "./packages/*" // 子项目统一放在某个目录下时可使用通配符匹配
  ]
}

• 配置完成后打包tgz即可，用户安装时包管理器会自动识别所有workspace下的子项目package.json，一次性拉取全部依赖。

方案2：预打包阶段合并所有依赖到根package.json #

如果不希望使用workspace特性，可以在打包tgz前执行脚本，自动合并所有子项目的依赖到根package.json对应字段中：

• 新增同步依赖的Node.js脚本sync-deps.js：

const fs = require('fs')
const path = require('path')

// 读取根package.json
const rootPkg = JSON.parse(fs.readFileSync('./package.json', 'utf-8'))
// 声明要合并的依赖类型
const depTypes = ['dependencies', 'devDependencies', 'peerDependencies', 'optionalDependencies']

// 遍历所有子项目目录
;['project1', 'project2'].forEach(projectDir => {
  const pkgPath = path.join(projectDir, 'package.json')
  if (!fs.existsSync(pkgPath)) return
  const subPkg = JSON.parse(fs.readFileSync(pkgPath, 'utf-8'))
  
  depTypes.forEach(type => {
    if (!subPkg[type]) return
    rootPkg[type] = Object.assign(rootPkg[type] || {}, subPkg[type])
  })
})

// 回写根package.json
fs.writeFileSync('./package.json', JSON.stringify(rootPkg, null, 2), 'utf-8')

• 打包前执行node sync-deps.js完成依赖合并，再执行打包命令即可。

方案3：配置postinstall钩子自动安装子项目依赖 #

在根package.json的脚本中添加postinstall钩子，根依赖安装完成后自动遍历子项目执行安装命令：

• 根package.json添加如下配置：

{
  "scripts": {
    "postinstall": "node -e \"const fs=require('fs'),cp=require('child_process');fs.readdirSync('.',{withFileTypes:true}).filter(d=>d.isDirectory()&&fs.existsSync(`./${d.name}/package.json`)).forEach(d=>cp.execSync('npm install',{cwd:`./${d.name}`,stdio:'inherit'}))\""
  }
}

注意：该方案存在一定安全风险，部分用户可能会默认禁用postinstall脚本执行，仅适合内部场景使用。

• 打包tgz时需要确保所有子项目的package.json文件都被包含，不要在.npmignore文件或者根package.json的files字段中排除子项目目录
• 如果使用pnpm作为包管理器，需要额外确保根目录的pnpm-workspace.yaml配置和package.json的workspaces字段匹配

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