在现代的软件开发中，管理项目依赖是一项重要的工作。Yarn workspace 是一个强大的工具，它可以帮助我们更好地管理多包项目中的依赖。今天咱们就来聊聊 Yarn workspace 依赖提升优化，也就是减少重复安装的配置技巧。
一、Yarn workspace 基础介绍
Yarn workspace 是 Yarn 提供的一个功能，它允许我们在一个项目中管理多个包。想象一下，你有一个大项目，里面包含了好几个小的子项目，每个子项目都有自己的依赖。要是没有 Yarn workspace，每个子项目都得单独安装依赖，这样就会造成很多重复的安装，浪费时间和磁盘空间。
比如说，你有一个项目结构是这样的：
my-project/
├── packages/
│ ├── package-a/
│ │ ├── package.json
│ │ └── src/
│ └── package-b/
│ ├── package.json
│ └── src/
└── package.json
在根目录的 package.json 里，我们可以这样配置来启用 Yarn workspace：
{
"name": "my-project",
"private": true,
"workspaces": [
"packages/*"
]
}
这里的 workspaces 字段指定了哪些目录是工作区。这样，Yarn 就知道这些目录下的包是可以共享依赖的。
二、依赖提升的原理
依赖提升其实就是把多个包中相同的依赖提升到根目录，避免每个包都单独安装。举个例子，package-a 和 package-b 都依赖 lodash 这个库。如果没有依赖提升，package-a 和 package-b 会分别安装 lodash，这就造成了重复。而有了依赖提升，Yarn 会把 lodash 安装到根目录，package-a 和 package-b 可以共享这个安装好的 lodash。
我们来看一个具体的例子。假设 package-a 的 package.json 如下：
{
"name": "package-a",
"version": "1.0.0",
"dependencies": {
"lodash": "^4.17.21"
}
}
package-b 的 package.json 如下：
{
"name": "package-b",
"version": "1.0.0",
"dependencies": {
"lodash": "^4.17.21"
}
}
当我们在根目录运行 yarn install 时，由于依赖提升，lodash 只会在根目录安装一次，而不是在 package-a 和 package-b 中分别安装。
三、配置技巧实现依赖提升
1. 使用 nohoist 选项
有时候，我们可能不希望某些依赖被提升到根目录。比如说，某个包需要特定版本的依赖，和其他包的版本不兼容。这时候就可以使用 nohoist 选项。
在根目录的 package.json 里，可以这样配置：
{
"name": "my-project",
"private": true,
"workspaces": {
"packages": [
"packages/*"
],
"nohoist": [
"packages/package-a/**"
]
}
}
这里的 nohoist 表示 package-a 及其子依赖都不会被提升到根目录。这样，package-a 就可以使用自己独立的依赖版本。
2. 统一依赖版本
为了更好地进行依赖提升，我们要尽量统一各个包中依赖的版本。比如说，所有包都使用 lodash 的 4.17.21 版本，这样 Yarn 就可以把 lodash 提升到根目录。
我们可以在根目录的 package.json 里使用 resolutions 字段来强制统一依赖版本：
{
"name": "my-project",
"private": true,
"workspaces": [
"packages/*"
],
"resolutions": {
"lodash": "4.17.21"
}
}
这样，不管 package-a 还是 package-b 声明的 lodash 版本是什么，最终都会使用 4.17.21 版本，并且可以提升到根目录。
四、应用场景
1. 多包项目开发
在大型的多包项目中，使用 Yarn workspace 依赖提升可以大大减少依赖安装的时间和磁盘空间。比如说，一个电商项目，有前端、后端、公共组件等多个包。这些包可能会有很多相同的依赖，通过依赖提升，就可以避免重复安装。
2. 团队协作开发
当团队多人协作开发时，每个开发者的环境可能会有差异。使用 Yarn workspace 依赖提升可以保证大家使用的依赖版本一致，减少因依赖版本不一致导致的问题。
五、技术优缺点
优点
- 节省磁盘空间：避免了重复安装相同的依赖，减少了磁盘空间的占用。
- 提高安装速度：由于只需要安装一次依赖，安装时间会大大缩短。
- 版本一致性：可以统一管理依赖版本，确保各个包使用的依赖版本一致。
缺点
- 配置复杂：需要对 Yarn workspace 和依赖提升有一定的了解，配置不好可能会出现问题。
- 兼容性问题：如果某些包对依赖版本有特殊要求，可能会导致兼容性问题。
六、注意事项
- 版本冲突：在统一依赖版本时，要确保各个包都能兼容这个版本。如果出现版本冲突，可能会导致项目无法正常运行。
nohoist使用要谨慎：nohoist会阻止依赖提升，使用过多可能会失去依赖提升的优势。要根据实际情况合理使用。- 定期清理缓存：有时候，Yarn 的缓存可能会导致依赖安装出现问题。定期清理缓存可以避免这些问题。可以使用
yarn cache clean命令来清理缓存。
七、文章总结
Yarn workspace 依赖提升是一个非常有用的功能，可以帮助我们更好地管理多包项目中的依赖。通过合理配置，我们可以减少重复安装，节省磁盘空间和安装时间。但是，在使用过程中，我们要注意版本冲突、nohoist 的使用等问题。只要掌握了这些技巧，就能让我们的项目开发更加高效。
评论