Patch-Package：一款灵活的开源依赖修复工具

news2024/9/21 4:30:07

一、背景

在现代软件开发中，开发者通常依赖大量的开源库来加快开发进程。然而，随着时间的推移，可能会遇到一些问题：

开源包的缺陷：开源库可能存在 Bug 或者与项目不兼容的问题。开发者可以自己修复这些问题，但将修改直接应用到库的源代码中并不是最佳做法，因为这会在更新库版本时导致修改丢失。
缺乏维护：某些开源项目由于某些原因，已经不再积极维护。开发者提交的 issue 和 PR（Pull Request）可能很长时间都得不到处理。
自定义需求：有时，开发者需要对开源库进行一些定制修改，以满足项目的特殊需求，而这些修改可能不适合提交给原项目。

以上情况催生了在本地快速、临时修改开源库的工具的需求。此工具能让开发者能够方便地在不影响原始代码的情况下应用补丁，同时保留这些修改的可追溯性和版本控制。

修改源码的几种方法

Patch-Package 允许开发者直接在 node_modules 中修改依赖包，然后通过生成补丁文件将这些修改保存下来。这个补丁文件可以和项目代码一起版本控制，在每次安装依赖时自动应用，确保修改不会丢失。

Fork 项目是另一种常见的方式。开发者可以将开源库的源码 Fork 到自己的代码仓库中，然后在 Fork 后的仓库中进行修改和维护。这样做的好处是可以完全控制代码的更新和发布，但也意味着需要承担较大的维护成本。

这些工具主要用于锁定依赖的版本，防止意外的版本更新。虽然它们不能直接修改源码，但在某些情况下可以通过选择特定的版本来避免问题。例如，使用 Yarn Resolutions 可以强制所有依赖项使用同一个子依赖的特定版本。

几个方法的比较

从上文可以看出，大部分项目都适合Patch-Package的方式满足需求

1.安装 Patch-Package

在项目中使用 npm 或 yarn 安装 patch-package：

npm install patch-package

或者使用 yarn：

yarn add patch-package

2.修改依赖包

直接在 node_modules 中找到需要修改的包，做出相应的改动。

3.生成补丁文件

修改完成后，运行以下命令来生成补丁文件：

npx patch-package <package-name>

例如：

npx patch-package element-plus

这将在项目的根目录生成一个 patches/ 文件夹，里面包含 element-plus+4.7.2.patch 这样的文件。

4.应用补丁

确保每次安装依赖时都应用补丁，需在 package.json 中的 scripts 部分添加以下内容

"scripts": {

 "postinstall": "patch-package"

5.提交补丁文件

生成的补丁文件可以和代码库一起提交到版本控制系统中，确保团队其他成员能同步修改。

尽管 Patch-Package 是一个强大的工具，但它只能解决临时问题。对于开源库的长期发展，向原始仓库提交 issue 或 PR 仍然是必要的步骤。在提交 issue 时，以下几点可以帮助提高被接受的概率：

详细描述问题：提供重现步骤、环境信息和相关日志。
提出解决方案：如果你有一个可能的解决方案，尝试提交 PR。
保持沟通：持续跟踪 issue 的状态，并在需要时补充更多信息。

五、其他需要注意的事项

补丁文件的管理：对于多个补丁文件，Patch-Package 会自动管理它们的应用顺序，确保依赖包的稳定性。

团队协作：通过版本控制系统共享补丁文件时，确保每个团队成员的开发环境一致，避免因 patch 没有应用而导致的环境不一致问题。

六、案例

问题

笔者在开发中，遇到element-plus中的select组件伴随value变化没有及时更新form表单检查项的问题。（原因是笔者对select的组件进行了二次封装，某些value的变化是在下一个 run loop发生的，而element-plus中的表单检查是线性触发的）

代码截图

七、结语

Patch-Package 是一个非常有用的工具，特别是在你需要快速修复依赖库的问题时。它让我们能够在不破坏原有开发流程的前提下进行灵活的修改，是开源项目和团队协作中的得力助手。通过掌握 Patch-Package 的使用方法和最佳实践，你可以大大提高项目的开发效率，避免依赖管理带来的困扰。