一、什么是 Yarn link
在咱们开发过程中，有时候会遇到这样的情况：你正在开发一个库，同时又有一个项目需要使用这个库进行测试。要是每次修改库代码都得打包发布到 npm 上再安装到项目里，那可太麻烦了。这时候，Yarn link 就派上用场啦。
Yarn link 是 Yarn 提供的一个命令，它可以在本地把一个包链接到另一个项目里，这样你在本地修改包的代码，使用这个包的项目就能马上看到变化，就好像这个包已经安装到项目里一样。
二、应用场景
1. 库开发与项目集成测试
假如你正在开发一个前端组件库，比如叫 my - component - library，同时有一个使用 React 框架的项目 my - react - project 需要使用这个组件库。在开发组件库的过程中，你需要不断测试组件在项目中的表现。这时候，就可以用 Yarn link 把 my - component - library 链接到 my - react - project 里。
2. 多项目协同开发
当你同时开发多个相互依赖的项目时，比如有一个基础工具库 base - utils，还有多个业务项目都依赖这个工具库。使用 Yarn link 可以方便地在本地调试，避免频繁发布和安装。
三、最佳实践
1. 初始化项目
咱们先创建两个项目，一个是库项目，一个是使用这个库的项目。这里以 Node.js 和 JavaScript 为例：
// 技术栈：Node.js、JavaScript
// 创建库项目
mkdir my - library
cd my - library
yarn init -y
// 创建使用库的项目
mkdir my - app
cd my - app
yarn init -y
2. 开发库项目
在 my - library 项目里，创建一个简单的模块。比如创建一个 index.js 文件：
// 技术栈：Node.js、JavaScript
// my - library/index.js
// 导出一个简单的函数
module.exports = {
sayHello: function () {
return 'Hello, World!';
}
};
3. 使用 Yarn link 链接库
在 my - library 项目目录下，执行 yarn link 命令：
cd my - library
yarn link
这时候，Yarn 会把这个库注册到全局的链接列表里。
然后，在 my - app 项目目录下，执行 yarn link my - library 命令：
cd my - app
yarn link my - library
这样，my - app 项目就可以使用 my - library 里的模块了。
4. 在项目中使用库
在 my - app 项目里，创建一个 index.js 文件来使用 my - library：
// 技术栈：Node.js、JavaScript
// my - app/index.js
// 引入 my - library
const myLibrary = require('my - library');
// 调用 my - library 里的函数
console.log(myLibrary.sayHello());
5. 实时调试
现在，你可以在 my - library 项目里修改代码，比如把 sayHello 函数的返回值改成 'Hello, Yarn link!'，然后在 my - app 项目里重新运行 node index.js，就能看到修改后的结果啦。
四、技术优缺点
优点
- 高效开发：避免了频繁打包发布和安装的过程，节省了大量时间。比如在开发组件库时，每次修改代码都能马上在项目里看到效果，大大提高了开发效率。
- 本地调试方便：可以在本地环境中轻松调试库和项目之间的交互，及时发现和解决问题。
缺点
- 环境依赖问题：如果链接的库依赖其他包，可能会出现版本不兼容的问题。比如库依赖的某个包版本和项目里的版本不一致，就可能导致运行出错。
- 全局链接管理复杂：当链接的库比较多的时候，管理起来会比较麻烦，容易出现链接混乱的情况。
五、常见陷阱及解决办法
1. 版本冲突
有时候，库和项目依赖的同一个包版本不同，就会导致版本冲突。比如 my - library 依赖 lodash@4.17.21，而 my - app 依赖 lodash@4.17.20。
解决办法：可以使用 yarn resolutions 来强制指定版本。在 my - app 的 package.json 里添加：
{
"resolutions": {
"lodash": "4.17.21"
}
}
然后重新安装依赖：
yarn install
2. 链接失效
有时候，可能会出现链接失效的情况，比如在重新安装依赖或者更新 Yarn 版本之后。
解决办法：可以先在 my - app 项目里执行 yarn unlink my - library 解除链接，然后重新在 my - library 项目里执行 yarn link，再在 my - app 项目里执行 yarn link my - library。
3. 缓存问题
Yarn 有缓存机制，有时候修改代码后可能不会马上生效。
解决办法：可以清除 Yarn 缓存，执行 yarn cache clean，然后重新运行项目。
六、注意事项
- 保持项目结构清晰：在使用 Yarn link 时，要确保项目结构清晰，避免出现文件路径混乱的情况。
- 及时更新依赖：当库或者项目的依赖发生变化时，要及时更新，避免版本冲突。
- 定期清理链接：如果不再使用某个链接，要及时解除链接，避免全局链接列表混乱。
七、文章总结
Yarn link 是一个非常实用的工具，它可以大大提高开发效率，让我们在本地开发调试过程中更加方便。但是，在使用过程中也会遇到一些问题，比如版本冲突、链接失效等。我们需要了解这些常见陷阱，并掌握相应的解决办法。同时，要注意项目结构的清晰和依赖的管理，这样才能更好地使用 Yarn link 进行开发。
评论