如何在多模块项目中抽离和共享公共package.json？

Question

假如我有多个模块，每个模块都有一个package.json，我想抽离出公共package.json，让模块公用继承一个通用的package.json，请问有什么好的实现方法吗？

Answer 1

推荐使用 Yarn Workspaces 和 Pnpm Workspaces 的方法：

使用 Yarn Workspaces

1.创建根目录的 package.json 文件： 在项目根目录下创建一个 package.json 文件，并添加 workspaces 字段：

{
  "private": true,
  "workspaces": [
    "packages/*"
  ]
}

2.创建模块目录： 在 packages 目录下为每个模块创建一个子目录，每个子目录中包含一个 package.json 文件。例如：

project-root/
├── packages/
│   ├── module1/
│   │   ├── package.json
│   │   └── src/
│   ├── module2/
│   │   ├── package.json
│   │   └── src/
├── package.json

3.安装依赖： 在项目根目录下运行 yarn install，Yarn 会自动安装所有模块的依赖，并将它们链接到根目录的 node_modules 中。

使用 Pnpm Workspaces

1.创建根目录的 package.json 文件： 在项目根目录下创建一个 package.json 文件，并添加 workspaces 字段：

{
  "private": true,
  "workspaces": [
    "packages/*"
  ]
}

2.创建 pnpm-workspace.yaml 文件： 在项目根目录下创建一个 pnpm-workspace.yaml 文件，并添加以下内容：

packages:
  - "packages/*"

3.创建模块目录： 在 packages 目录下为每个模块创建一个子目录，每个子目录中包含一个 package.json 文件。例如：

project-root/
├── packages/
│   ├── module1/
│   │   ├── package.json
│   │   └── src/
│   ├── module2/
│   │   ├── package.json
│   │   └── src/
├── package.json
└── pnpm-workspace.yaml

4.安装依赖： 在项目根目录下运行 pnpm install，Pnpm 会自动安装所有模块的依赖，并将它们链接到根目录的 node_modules 中。

补充

Yarn Workspaces

优点：

• 简单易用：配置简单，易于上手。
• 广泛使用：社区支持广泛，文档丰富。
• 与 Lerna 结合：可以与 Lerna 结合使用，提供更强大的版本管理和发布功能。

缺点：

• 性能：在处理非常大型项目时，性能可能不如 Pnpm。

Pnpm Workspaces

优点：

• 高效依赖管理：通过硬链接和符号链接节省磁盘空间，安装速度快。
• 性能优越：在大型项目中表现出色，依赖管理更高效。
• 分布式缓存：支持分布式缓存，进一步提升构建速度。

缺点：

• 相对较新：虽然越来越受欢迎，但社区支持和文档可能不如 Yarn 丰富。

总结

• 大型项目：推荐使用 Pnpm Workspaces。
• 中小型项目：推荐使用 Yarn Workspaces