git忽略node_modules

1. 介绍

在开发过程中，我们通常会使用一些第三方库以及工具来辅助我们的开发工作。其中，node.js是一个非常流行的开发平台，它拥有许多强大的工具和库供我们使用。在使用这些工具和库的过程中，我们通常会使用npm（Node.js的包管理器）来安装和管理依赖。当我们在项目中使用npm安装依赖时，npm会自动创建一个名为node_modules的文件夹，并将所有的依赖项都安装在其中。但是，node_modules文件夹通常会非常大，并且其中包含了很多文件。如果将node_modules文件夹提交到Git仓库中，会导致仓库变得非常庞大，给项目的协作和部署带来不便。因此，我们需要将node_modules文件夹排除在Git版本控制之外，即忽略它。

本文将详细介绍在Git中忽略node_modules文件夹的方法。

2. 为什么要忽略`node_modules`文件夹

node_modules文件夹通常包含了项目中所有的依赖项，它的体积会非常庞大。如果将这个文件夹提交到Git仓库中，会导致仓库的体积非常大，不利于代码的协作和版本控制。此外，在项目部署时，通常可以根据package.json文件中的依赖列表，通过运行npm install命令自动安装所有的依赖项。因此，将node_modules文件夹提交到Git仓库中是没有必要的，甚至是不推荐的。

3. 忽略`node_modules`文件夹的方法

在Git中，有多种方法可以忽略node_modules文件夹，本文将介绍常用的两种方法：使用.gitignore文件和使用.npmignore文件。

3.1 使用`.gitignore`文件

.gitignore文件是一个文本文件，其中包含了Git应该忽略的文件和文件夹的规则。我们可以通过在项目根目录下创建一个名为.gitignore的文件，并在其中添加node_modules/一行来忽略node_modules文件夹。

以下是一个示例的.gitignore文件的内容：

node_modules/

3.2 使用`.npmignore`文件

.npmignore文件类似于.gitignore文件，不同之处在于，它是用来指定在发布npm包时应该被忽略的文件和文件夹的规则。我们可以通过在项目根目录下创建一个名为.npmignore的文件，并在其中添加node_modules/一行来忽略node_modules文件夹。

以下是一个示例的.npmignore文件的内容：

node_modules/

注意：为了避免混淆，我们通常会将.gitignore和.npmignore文件都添加到Git仓库中，并保持它们的内容一致。

4. `.gitignore` vs `.npmignore`

.gitignore文件和.npmignore文件在某些方面是相似的，但也有一些细微的区别。

首先，.gitignore文件的作用范围是Git仓库，它会影响Git对文件和文件夹的版本控制。而.npmignore文件的作用范围是npm包，在发布npm包时，它会指定哪些文件在npm包中应该被忽略。

其次，.gitignore文件通常是在项目的根目录下创建的，并且它会递归地应用到整个项目。而.npmignore文件通常是在npm包的根目录下创建的，并且它只会影响npm包自身。

第三，.gitignore文件可以包含更多的规则，例如注释和模式匹配。而.npmignore文件只能包含文件和文件夹的名称或者glob模式。

最后，.gitignore文件的规则会被Git递归地应用到子文件夹和子模块中。而.npmignore文件的规则不会被npm递归地应用到子npm包中。因此，在发布npm包时，如果希望忽略子npm包中的node_modules文件夹，需要在子npm包中单独创建.npmignore文件并指定忽略规则。

5. 验证忽略规则是否生效

在配置完.gitignore或.npmignore文件后，我们需要验证忽略规则是否生效。我们可以使用git status命令查看文件的状态，并确保node_modules文件夹不会出现在修改的文件列表中。

以下是一个示例的输出结果：

$ git status
On branch master
Your branch is up to date with 'origin/master'.

nothing to commit, working tree clean

6. 其他注意事项

6.1 忽略已经被Git追踪的文件夹

如果node_modules文件夹已经被Git追踪，即已经存在于Git仓库中，那么.gitignore文件将无法忽略它。在这种情况下，我们可以使用git rm命令将node_modules文件夹从Git仓库中删除，但保留在本地文件系统中。删除后，再将node_modules文件夹添加到.gitignore文件中并提交修改。

以下是删除并忽略已被追踪的node_modules文件夹的步骤：
1. 删除已被追踪的node_modules文件夹：git rm -r --cached node_modules
2. 将node_modules/添加到.gitignore文件中
3. 提交.gitignore文件的修改：git add .gitignore 和 git commit -m "Update .gitignore"
4. 推送修改后的.gitignore文件到远程仓库：git push origin master

6.2 删除已经提交的`node_modules`文件夹

如果node_modules文件夹已经被提交到Git仓库，并且我们希望从Git仓库中删除它，但保留在本地文件系统中，那么我们可以使用git filter-branch命令来删除node_modules文件夹的所有历史记录。

以下是删除已提交的node_modules文件夹的步骤：
1. 创建一个空的临时目录：mkdir temp
2. 切换到临时目录：cd temp
3. 将Git仓库克隆到临时目录：git clone <remote_repository_url4. 进入克隆下来的临时目录：cd 5. 使用git filter-branch命令删除node_modules文件夹的所有历史记录： ```bash git filter-branch --tree-filter 'rm -rf node_modules' --prune-empty HEAD ``` 6. 等待命令执行完毕，删除临时目录中的.git文件夹：rm -rf .git7. 回到原项目根目录：cd ..8. 将临时目录中的所有文件复制到原项目根目录中：cp -r /. .9. 删除临时目录：rm -rf 10. 添加node_modules/到.gitignore文件中 11. 提交.gitignore文件的修改：git add .gitignore和git commit -m “Update .gitignore”12. 推送修改后的.gitignore文件到远程仓库：git push origin master`