node.js - 在单一存储库中的多个项目之间共享模块

Question

我有一个包含几个项目的小型 monorepo(它们共享相同的数据存储，因此更容易将它们放在 monorepo 中进行开发和测试)。每个项目都位于自己的文件夹中，并具有自己的 package.json。每个项目都应该单独部署(独立于其他项目)。

我想在项目之间共享一些代码。我想保持它们的相对独立性，因此我宁愿不必在根存储库文件夹中创建“构建”步骤，也不必让每个项目都有自己的构建步骤。理想情况下，每个项目的部署将继续在项目的文件夹中完成，而不需要了解其他项目。

我知道我可以在存储库中创建一个 npm 模块，并且 npm link从每个项目到它。这是我倾向于的解决方案。但我想知道是否有人有更好的主意。

以下是目录结构的示例:

/package.json
/docker-compose.yml
/project-1/package.json
/project-2/package.json

如果我选择 npm link解决方案，我会添加类似 project-shared 的内容文件夹并从 project-1 链接到它和project-2 .

Answer 1

这是我目前正在使用的 npm 链接解决方案。这似乎是一个不错的解决方案，所以我想我会将其作为答案发布。我还没有实现这个项目的部署内容，所以我不知道部署对此的效果如何。我希望它将与其他所有内容一起部署链接的模块。

项目目录结构如下:

/package.json
/docker-compose.yml
/project-1/package.json
/project-2/package.json
/project-shared/package.json

在每个项目的 package.json(project-1 和 project-2)中，我添加了以下安装后脚本:

"scripts": {
  "postinstall": "npm link ../project-shared"
},

因此链接将在项目的正常设置期间创建。

注意:由于某种原因，使用预安装脚本无法正常工作(链接不会被创建，尽管它看起来像是在运行)。 postinstall 工作得很好。

我不太确定共享模块的依赖项安装如何工作(例如，当项目链接到共享模块时是否会安装共享模块的依赖项，或者我是否必须独立安装它们)。

我遇到的一个问题是 Docker Compose 不能很好地处理链接包(符号链接(symbolic link)文件夹不会指向容器内的正确位置)。我通过在 node_modules 文件夹中的符号链接(symbolic link)上安装共享文件夹来修复此问题。例如，对于 project-1:

volumes:
  - "./project-1/:/home/node/app:ro"
  - "./project-shared/:/home/node/app/node_modules/project-shared:ro"

编辑:2020 年 9 月 4 日

想指出的是，我已经在生产中使用它一段时间了，而且效果很好。我在开发中注意到的一个问题是，当共享库安装在 Docker 容器中时，当您从主机上进行 npm install 时，它将运行 postinstall 并符号链接(symbolic link)您的共享库库文件夹。这是预期的，但在 Docker 中它会弄乱你的挂载。我找到的解决方案是停止 Docker，删除链接，重新创建文件夹，然后再次启动 Docker。更好的解决方案可能是将您的 postinstall 脚本替换为如下内容:

"postinstall": "test -d node_modules/project-shared || npm link ../project-shared"

这只会链接该文件夹(如果该文件夹尚不存在)。我只对此进行了一点测试，所以我不确定是否遗漏了任何奇怪的边缘情况。

编辑:2023 年 2 月 22 日

如今，这不是一个好的选择。所有包管理器现在都支持 monorepos，您可以轻松地将其他包的依赖项包含在存储库中。