394

我在这里遵循了 Heroku 上 Node.js 的基本入门说明：

https://devcenter.heroku.com/categories/nodejs

这些指令没有告诉您创建 .gitignore node_modules，因此暗示应该将文件夹node_modules签入到 Git。当我在 Git 存储库中包含node_modules时，我的入门应用程序运行正常。

当我在以下位置遵循更高级的示例时：

它指示我将文件夹node_modules添加到文件.gitignore。所以我从 Git 中删除了 node_modules文件夹，将其添加到文件.gitignore中，然后重新部署。这次部署失败，如下所示：

-----> Heroku receiving push
-----> Node.js app detected
-----> Resolving engine versions
       Using Node.js version: 0.8.2
       Using npm version: 1.0.106
-----> Fetching Node.js binaries
-----> Vendoring node into slug
-----> Installing dependencies with npm
       Error: npm doesn't work with node v0.8.2
       Required: node@0.4 || 0.5 || 0.6
           at /tmp/node-npm-5iGk/bin/npm-cli.js:57:23
           at Object.<anonymous> (/tmp/node-npm-5iGk/bin/npm-cli.js:77:3)
           at Module._compile (module.js:449:26)
           at Object.Module._extensions..js (module.js:467:10)
           at Module.load (module.js:356:32)
           at Function.Module._load (module.js:312:12)
           at Module.require (module.js:362:17)
           at require (module.js:378:17)
           at Object.<anonymous> (/tmp/node-npm-5iGk/cli.js:2:1)
           at Module._compile (module.js:449:26)
       Error: npm doesn't work with node v0.8.2
       Required: node@0.4 || 0.5 || 0.6
           at /tmp/node-npm-5iGk/bin/npm-cli.js:57:23
           at Object.<anonymous> (/tmp/node-npm-5iGk/bin/npm-cli.js:77:3)
           at Module._compile (module.js:449:26)
           at Object.Module._extensions..js (module.js:467:10)
           at Module.load (module.js:356:32)
           at Function.Module._load (module.js:312:12)
           at Module.require (module.js:362:17)
           at require (module.js:378:17)
           at Object.<anonymous> (/tmp/node-npm-5iGk/cli.js:2:1)
           at Module._compile (module.js:449:26)
       Dependencies installed
-----> Discovering process types
       Procfile declares types -> mongod, redis, web
-----> Compiled slug size is 5.0MB
-----> Launching... done, v9

运行“heroku ps”确认崩溃。好的，没问题，所以我回滚了更改，将文件夹node_module添加回 Git 存储库并将其从文件.gitignore中删除。但是，即使在还原后，我仍然在部署时收到相同的错误消息，但现在应用程序再次正常运行。运行“heroku ps”告诉我应用程序正在运行。

这样做的正确方法是什么？是否包含文件夹node_modules？为什么回滚时仍然会收到错误消息？我的猜测是 Git 存储库在 Heroku 方面的状态不佳。

4

12 回答 12

404

第二次更新

常见问题解答不再可用。

从以下文档shrinkwrap：

如果您希望锁定包中包含的特定字节，例如对能够重现部署或构建有 100% 的信心，那么您应该将您的依赖项检查到源代码控制中，或者采用其他一些可以验证的机制内容而不是版本。

香农和史蒂文之前提到过这一点，但我认为这应该是公认答案的一部分。

更新

以下建议列出的来源已更新。他们不再建议提交该node_modules文件夹。

通常，没有。允许 npm 为您的包解析依赖项。

对于您部署的包，例如网站和应用程序，您应该使用 npm shrinkwrap 锁定您的完整依赖关系树：

https://docs.npmjs.com/cli/shrinkwrap

原帖

作为参考，npm FAQ 清楚地回答了您的问题：

将 node_modules 检入 git 以获取您部署的内容，例如网站和应用程序。不要将 node_modules 签入 git 以获取打算重用的库和模块。使用 npm 管理开发环境中的依赖项，而不是部署脚本中的依赖项。

并为此提供一些很好的理由，请阅读Mikeal Rogers 的帖子。

来源：https ://docs.npmjs.com/misc/faq#should-i-check-my-node-modules-folder-into-git

于 2013-10-17T00:46:38.657 回答
169

对于不将文件夹node_modules 检入 Git，我最大的担忧是 10 年后，当您的生产应用程序仍在使用时，npm 可能不存在了。或者 npm 可能会损坏；或者维护人员可能决定从他们的存储库中删除您依赖的库；或者您使用的版本可能会被删减。

这可以通过Maven等存储库管理器来缓解，因为您始终可以使用自己的本地Nexus (Sonatype) 或Artifactory来维护您使用的包的镜像。据我了解，npm 不存在这样的系统。Bower和Jam.js等客户端库管理器也是如此。

如果您已将文件提交到自己的 Git 存储库，那么您可以随时更新它们，并且您可以轻松地进行可重复构建，并且知道您的应用程序不会因为某些第三方操作而中断。

于 2013-02-13T11:50:36.277 回答
70

您不应该在.gitignore文件中包含文件夹node_modules（或者您应该在部署到 Heroku的源代码中包含文件夹node_modules ）。

如果文件夹node_modules：

  • 存在然后npm install将使用那些供应商的库，并将重建任何二进制依赖项npm rebuild。
  • 不存在则npm install必须自己获取所有依赖项，这会增加 slug 编译步骤的时间。

有关这些确切步骤，请参阅 Node.js buildpack 源代码。

但是，最初的错误看起来是npm和 Node.js版本之间的不兼容。始终根据本指南明确设置packages.jsonengines文件的部分是一个好主意，以避免这些类型的情况：

{
  "name": "myapp",
  "version": "0.0.1",
  "engines": {
    "node": "0.8.x",
    "npm":  "1.1.x"
  }
}

这将确保开发/生产平价，并减少未来发生此类情况的可能性。

于 2012-07-12T20:42:32.383 回答
25

在发表此评论后，我打算离开：在 Heroku 上创建 Node.js 应用程序时，我应该将文件夹“node_modules”签入 Git 吗？

但是 Stack Overflow 的格式很奇怪。

如果您没有相同的机器并且正在检查 node_modules，请在本机扩展上执行 .gitignore。我们的 .gitignore 看起来像：

# Ignore native extensions in the node_modules folder (things changed by npm rebuild)
node_modules/**/*.node
node_modules/**/*.o
node_modules/**/*.a
node_modules/**/*.mk
node_modules/**/*.gypi
node_modules/**/*.target
node_modules/**/.deps/
node_modules/**/build/Makefile
node_modules/**/**/build/Makefile

通过首先检查所有内容进行测试，然后让另一个开发人员执行以下操作：

rm -rf node_modules
git checkout -- node_modules
npm rebuild
git status

确保没有文件更改。

于 2014-09-05T22:03:32.187 回答
11

我认为不npm install应该在生产环境中运行。有几件事可能会出错 - npm 中断，下载较新的依赖项（shrinkwrap似乎已经解决了这个问题）是其中两个。

另一方面，不应将文件夹node_modules提交给 Git。除了它们的大尺寸之外，包括它们在内的提交可能会分散注意力。

最好的解决方案是：npm install应该在类似于生产环境的CI环境中运行。所有测试都将运行，并且将创建一个包含所有依赖项的压缩发布文件。

于 2015-04-29T09:47:22.650 回答
9

我一直在使用提交node_modules文件夹和收缩包装。两种解决方案都没有让我高兴。

简而言之：一个提交的node_modules文件夹给存储库增加了太多的噪音。而且shrinkwrap.json不容易管理，并且不能保证一些收缩包装的项目将在几年内构建。

我发现 Mozilla 正在为他们的一个项目使用单独的存储库：https ://github.com/mozilla-b2g/gaia-node-modules

所以没多久我就在 Node.js CLI 工具中实现了这个想法：https ://github.com/bestander/npm-git-lock

在每次构建之前，添加：

npm-git-lock --repo [git@bitbucket.org:your/dedicated/node_modules/git/repository.git]

它将计算您的package.json文件的哈希值，并从远程存储库中检出文件夹node_modules内容，或者，如果这是此package.json文件的第一次构建，将执行清理npm install并将结果推送到远程存储库。

于 2015-04-19T13:51:05.277 回答
6

将 npm 版本显式添加到文件package.json ("npm": "1.1.x") 并且不将文件夹node_modules 签入 Git 对我有用。

部署可能会更慢（因为它每次都下载包），但我无法在签入时编译包。Heroku 正在寻找只存在于我的本地机器上的文件。

于 2012-07-13T14:12:13.410 回答
4

不要签入文件夹node_modules，而是为您的应用程序创建一个package.json文件。

package.json 文件指定应用程序的依赖项。Heroku 然后可以告诉 npm 安装所有这些依赖项。您链接到的教程包含有关package.json文件的部分。

于 2012-07-12T19:56:12.993 回答
4

来自Git 中的“node_modules”：

回顾一下。

  • 仅为您部署的应用程序签入 node_modules，而不是您维护的可重用包。
  • 任何编译的依赖项都应该签入它们的源，而不是编译目标，并且应该在部署时 $ npm rebuild。

我最喜欢的部分：

所有在你的 gitignore 中添加 node_modules 的人，删除那个狗屎，今天，它是一个我们都乐于留下的时代的产物。全局模块的时代已经结束。

（原来的链接是这个，但现在已经死了。感谢@Flavio指出它。）*

于 2014-02-10T09:15:23.407 回答
3

我正在使用这个解决方案：

  1. 创建一个包含文件夹node_modules的单独存储库。如果您有应为特定平台构建的本机模块，则为每个平台创建一个单独的存储库。

  2. 将这些存储库附加到您的项目存储库git submodule：

    git submodule add .../your_project_node_modules_windows.git node_modules_windows

    git submodule add .../your_project_node_modules_linux_x86_64 node_modules_linux_x86_64

  3. 创建从平台特定node_modules到node_modules目录的链接并添加node_modules到.gitignore.

  4. 运行npm install。

  5. 提交子模块存储库更改。

  6. 提交您的项目存储库更改。

因此，您可以轻松地在不同平台之间切换node_modules（例如，如果您在 OS X 上开发并部署到 Linux）。

于 2015-08-27T21:24:24.903 回答
3

场景一：

一种情况：

您使用从 npm 中删除的包。如果您在 node_modules 文件夹中拥有所有模块，那么这对您来说不是问题。如果你在 package.json 中只有包名，你就不能再得到它了。

如果一个包的使用时间少于 24 小时，您可以轻松地将其从 npm 中删除。如果它超过 24 小时，那么您需要联系他们。

但：

如果您联系支持人员，他们将检查删除该版本的软件包是否会破坏任何其他安装。如果是这样，我们不会删除它。

阅读更多

所以这种情况的可能性很低，但有第二种情况......

场景二：

这种情况的另一种情况：

你开发一个企业版的软件或一个非常重要的软件，并在你的 package.json 中写：

"dependencies": {
    "studpid-package": "~1.0.1"
}

你使用function1(x)那个包的方法。

现在 studpid-package 的开发人员将方法重命名function1(x)为function2(x)并且他们犯了一个错误......他们将包的版本从 更改1.0.1为1.1.0。这是一个问题，因为当您npm install下次调用时，您将接受版本1.1.0，因为您使用了波浪号 ( "studpid-package": "~1.0.1")。

现在调用function1(x)可能会导致错误和问题。

将整个 node_modules 文件夹（通常超过 100 MB）推送到您的存储库，将占用您的内存空间。与数百 MB（package.json 和 node_modules）相比，只有几 kb（仅 package.json）……想想看。

如果出现以下情况，您可以这样做/应该考虑一下：

  • 软件非常重要。

  • 当某些事情失败时，它会花费你的钱。

  • 你不信任 npm 注册表。npm 是集中式的，理论上可以关闭。

在 99.9% 的情况下，您不需要发布 node_modules 文件夹，如果：

  • 您只为自己开发软件。

  • 你已经编写了一些程序，只是想在 GitHub 上发布结果，因为其他人可能会对它感兴趣。

如果您不希望 node_modules 出现在您的存储库中，只需创建一个.gitignore文件并添加行node_modules.

于 2019-01-01T14:23:25.943 回答
2

如果您正在滚动您自己的特定于您的应用程序的模块，您可以：

  • 将那些（并且只有那些）保留在应用程序的/node_modules文件夹中，并将所有其他依赖项移出到父../node_modules文件夹。这将起作用，因为 NodeJS CommonJS 模块系统如何通过向上移动到父目录等方式工作，直到到达树的根目录。见：https ://nodejs.org/api/modules.html

  • 或者 gitignore/node_modules/* 除了你的/node_modules/your-modules. 请参阅：使 .gitignore 忽略除少数文件之外的所有内容

这个用例非常棒。它使您可以很好地保留您专门为您的应用程序创建的模块，并且不会与可以稍后安装的依赖项混淆。

于 2014-07-02T20:13:08.177 回答