git ignore

1. 什么是.gitignore文件

在使用Git进行版本控制时，我们经常会遇到一些不需要纳入版本控制的文件或文件夹，如编译生成的可执行文件、配置文件等。为了避免这些文件被意外地添加到版本库中，我们可以创建一个名为.gitignore的文件来指定忽略哪些文件和文件夹。

2. .gitignore的基本语法

2.1 选择忽略文件的基本规则

.gitignore文件中可以使用简单模式或者扩展模式指定要忽略的文件。

简单模式：每行指定一个文件或者文件夹的相对路径。例如，”./build/”表示忽略当前目录下的build文件夹。
扩展模式：可以使用星号（）匹配任意字符，或者使用问号（?）匹配单个字符。例如，”.txt”表示忽略所有的txt文件，”test?.”则表示以test开头，以一个任意字符结尾的文件。

2.2 忽略规则的说明

在.gitignore文件中，除了基本规则，还可以使用一些特殊字符和标记来表达更复杂的忽略规则。

注释：使用#开头的行表示注释，Git会忽略这些行。
反斜杠（/）：在行的开头表示要忽略的文件或文件夹位于当前文件夹下，而不是子文件夹。例如，”/build/”表示忽略根目录下的build文件夹，而不会忽略子目录下的build文件夹。
感叹号（!）：在行的开头表示取反，取消忽略该文件或文件夹。例如，”!build/test.txt”表示虽然前面的规则会忽略build文件夹下的所有文件，但是test.txt除外。

3. 常见的.gitignore规则示例

以下是一些常见的.gitignore规则示例，供参考使用。

3.1 忽略指定文件或文件夹

例如，忽略.vscode文件夹和.idea文件夹：

.vscode/
.idea/

3.2 忽略指定类型的文件

例如，忽略所有的.txt文件和所有的log文件：

*.txt
*.log

3.3 忽略指定文件夹下的文件

例如，忽略build文件夹下的所有文件和文件夹：

build/

3.4 忽略指定路径的文件

例如，忽略根目录下的config.properties文件：

/config.properties

3.5 取消忽略特定文件或文件夹

例如，取消忽略docs文件夹和docs/test.txt文件：

!docs/
!docs/test.txt

4. .gitignore文件的位置

4.1 在仓库的根目录下创建.gitignore文件

在Git仓库的根目录下创建.gitignore文件，并添加需要忽略的规则。这样，该规则将会作用于整个仓库。

4.2 在项目中创建.gitignore文件

有时，我们希望某些忽略规则只对某个项目或者某个文件夹有效。这时，可以在项目文件夹中创建.gitignore文件，并在其中添加相应的规则。

4.3 忽略全局的.gitignore文件

Git还支持在全局范围内设置忽略规则，使其对所有Git仓库都生效。可以通过以下命令来设置全局的.gitignore文件：

git config --global core.excludesFile ~/.gitignore_global

然后，可以在用户目录下创建.gitignore_global文件，并编辑其中的规则。

5. 验证.gitignore规则是否生效

可以通过以下步骤来验证.gitignore规则是否生效。

确保你已经将.gitignore文件添加到版本控制中。
在终端中执行git check-ignore -v path/to/file命令，将path/to/file替换为要验证的文件路径。如果命令没有输出任何信息，则表示该文件是被忽略的。
如果.gitignore规则没有生效，可以通过以下方式进行故障排查：
- 检查.gitignore文件的路径和文件名是否正确。
- 检查.gitignore规则是否正确并且位于正确的文件中。
- 检查.gitignore文件是否已经被正确地添加到版本控制中。

6. 总结

.gitignore文件是Git仓库中的一个重要组成部分，用于指定哪些文件或文件夹应该被忽略。通过灵活运用.gitignore规则，可以避免不必要文件被纳入版本控制，提高仓库的整洁性和可维护性。在实际开发中，根据项目的具体情况和需求来设置.gitignore规则，以保证项目的版本控制工作的有效进行。