如何在本地软件包的依赖项中使用 npm 软件包的本地副本？

如何在另一个本地软件包的依赖项中使用 npm 软件包的本地副本？

问题

想像一下，你有两个克隆的 React 项目：game-react 和 game-renderer。game-react 依赖于 game-renderer，但你想使用 game-renderer 的本地更改。如何实现这一目标，以便在运行 game-react 时，它可以获取 game-renderer 中的更改？

解决方案

为了使用 npm 软件包的本地副本作为另一个本地软件包的依赖项，我们使用以下步骤：

1. 创建符号链接

在 game-react 项目的根目录中，创建一个指向 game-renderer 项目的符号链接：

ln -s ../game-renderer game-renderer-local

这将在 game-react 中创建一个名为 game-renderer-local 的符号链接，该链接指向 game-renderer 项目。

2. 修改 package.json

在 game-react/package.json 中，将 game-renderer 依赖项修改为指向本地符号链接：

"dependencies": {
  "@gamets/game-renderer": "file:game-renderer-local",
}

这告诉 npm 在 game-renderer 项目中使用本地副本，而不是从 npm 注册表中安装它。

3. 安装依赖项

在 game-react 项目中，运行以下命令安装依赖项：

npm install

这将安装 game-renderer 的本地副本作为 game-react 的依赖项。

优点

这种方法的好处包括：

• 快速迭代： 无需发布到 npm 注册表，即可快速测试本地更改。
• 本地控制： 保持对 game-renderer 项目的完全控制，而无需担心与 npm 注册表同步。
• 协作： 允许团队成员在不影响彼此代码的情况下在本地进行更改。

注意

• 这种方法仅适用于本地开发，不能用于生产环境。
• 如果 game-renderer 项目发生更改，需要更新 game-react 项目中的符号链接和 package.json。

常见问题解答

1. 我可以在不创建符号链接的情况下执行此操作吗？

不行，符号链接是使 game-react 项目知道 game-renderer 的本地位置所必需的。

2. 我可以将此方法用于 npm 注册表中的其他软件包吗？

否，此方法仅适用于本地软件包。

3. 如果我发布了 game-react 软件包，会发生什么？

其他人将无法访问 game-renderer 的本地副本。他们需要安装自己的本地副本或从 npm 注册表中安装它。

4. 我可以在其他编程语言中使用此方法吗？

此方法适用于使用 npm 包管理器的语言，例如 JavaScript 和 TypeScript。

5. 这是否比使用 git 子模块更好？

git 子模块是一个替代方案，但符号链接方法通常更简单，因为它不需要额外的配置或跟踪远程存储库。