gitignore忽略文件夹

什么是.gitignore文件

在使用Git进行版本控制时，你可以创建.gitignore文件来告诉Git忽略某些文件或文件夹的变动。.gitignore文件可以用来忽略一些非必要的文件，以避免提交到代码仓库中。

.gitignore文件的格式

.gitignore文件是一个纯文本文件，每一行代表一个忽略的规则。规则的写法有一些常见的格式：

使用斜杠”/”开头表示忽略某个文件夹，比如/build/表示忽略名为build的文件夹。
使用斜杠”/”结尾表示忽略某个文件夹下的所有文件，比如/logs/表示忽略logs文件夹中的所有文件。
使用星号”*”表示通配符，可以匹配任意长度的字符，比如*.log表示忽略所有以.log结尾的文件。
使用问号”?”表示匹配任意一个字符，比如?.txt表示忽略所有名字为一个字符加上.txt后缀的文件。
使用感叹号”!”表示不忽略某个文件或文件夹，比如!important.txt表示不忽略名为important.txt的文件。
使用井号”#”表示注释，这一行的内容将被忽略。

忽略文件夹的场景

在实际项目开发中，经常会遇到需要忽略某些文件夹的情况。下面是几个常见场景：

1. 编译生成的文件夹

在项目中，我们通常会有一些编译生成的文件夹，比如build、dist等。这些文件夹中的内容并不需要提交到代码仓库中，因为它们可以通过源代码重新生成。

在.gitignore文件中忽略这些文件夹可以避免将它们误提交到代码仓库中，从而减小仓库的大小并保持代码仓库的干净。

示例：在.gitignore文件中添加/build/和/dist/，表示忽略build和dist文件夹下的所有文件。

/build/
/dist/

2. 依赖管理工具生成的文件夹

在使用一些依赖管理工具时，比如npm、Yarn等，通常会生成一个名为node_modules的文件夹，用于存放项目所依赖的第三方库。

由于node_modules文件夹中的内容非常庞大且经常变动，将其纳入版本控制并不是一个好的选择。通常我们会在.gitignore文件中忽略node_modules文件夹，以减小代码仓库的大小。

示例：在.gitignore文件中添加/node_modules/，表示忽略node_modules文件夹下的所有文件。

/node_modules/

3. 本地配置文件夹

在开发过程中，我们经常会有一些本地配置文件夹，比如.idea、.vscode等。这些文件夹中的内容通常只在本地有效，不应该提交到代码仓库中。

通过在.gitignore文件中忽略这些文件夹，可以避免将本地配置文件提交到仓库中，并且可以保护隐私信息。

示例：在.gitignore文件中添加/.idea/和/.vscode/，表示忽略.idea和.vscode文件夹下的所有文件。

/.idea/
/.vscode/

4. 临时文件夹

在开发过程中，我们可能会产生一些临时文件夹，比如备份文件夹、日志文件夹等。这些文件夹中的内容通常是临时的，不需要提交到代码仓库中。

通过在.gitignore文件中忽略这些文件夹，可以避免将临时文件提交到仓库中，保持仓库的清洁。

示例：在.gitignore文件中添加/backup/和/logs/，表示忽略backup和logs文件夹下的所有文件。

/backup/
/logs/

.gitignore文件的注意事项

在使用.gitignore文件时，有一些注意事项需要注意：

忽略文件夹时，推荐使用斜杠”/”开头和结尾，并且路径应该相对于.gitignore文件的位置。这样可以确保.gitignore文件在任何子文件夹下都能生效。
如果需要忽略的文件夹已经被Git版本控制，需要先将其从版本控制中删除，然后再将其添加到.gitignore文件中。可以使用命令git rm -r --cached 文件夹名来删除已经被版本控制的文件夹。
.gitignore文件可以放在项目的任何级别，它的作用范围会延伸到所有子文件夹中。如果某个子文件夹中有自己的.gitignore文件，它会覆盖上层的.gitignore文件。

.gitignore文件的实际示例

下面是一个实际项目中的.gitignore文件示例：

# 忽略以"~"结尾的临时文件
*~

# 忽略.mtml编译生成的文件
/build/

# 忽略npm生成的文件夹
/node_modules/

# 忽略VS Code的配置文件夹
/.vscode/

# 忽略.idea的配置文件夹
/.idea/

# 忽略备份文件夹
/backup/

# 忽略日志文件夹
/logs/