gitignore 文件语法详解

.gitignore 文件语法详解

在使用 Git 进行版本控制时，.gitignore 文件是一个非常重要的配置文件。它用于告诉 Git 哪些文件或目录不需要被纳入版本管理，即忽略它们。合理配置 .gitignore 文件不仅可以保持仓库的清洁，也能避免一些不必要的文件（如日志、编译产物、临时文件等）被提交到 Git 仓库中。

本篇博客将详细讲解 .gitignore 文件的语法规则、常见使用场景以及一些最佳实践。

1. .gitignore 文件的基本作用

.gitignore 文件允许你指定哪些文件或文件夹在版本控制时被忽略。这通常用于：

忽略编译生成的文件（如 .class、.o 等）。
忽略依赖文件（如 node_modules、vendor 等）。
忽略临时文件（如 IDE 的配置文件、操作系统生成的文件等）。

当 .gitignore 文件中指定的文件或目录匹配时，Git 会在执行相关操作（如 git add）时忽略它们。

2. .gitignore 文件的语法规则

2.1 基本语法

单个文件或目录
- 文件路径：可以直接写文件或文件夹的相对路径。
- 例如：*.log 表示所有 .log 后缀的文件都会被忽略。
注释
- 在 .gitignore 文件中，行以 # 开头的是注释，它会被 Git 忽略，不会影响忽略规则。
- 例如：# 忽略所有的日志文件。
通配符
- *：匹配任意字符（包括路径分隔符 /）。例如，*.log 会忽略所有 .log 后缀的文件。
- ?：匹配一个字符。用于匹配文件名中的一个字符。
- **：匹配任意目录级别的路径。用来匹配多个子目录层级中的文件或文件夹。

2.2 路径规则

忽略某个文件或文件夹
- file.txt：忽略仓库根目录下的 file.txt 文件。
- folder/：忽略仓库根目录下的 folder 文件夹。
- *.log：忽略所有 .log 后缀的文件。
相对路径
- 使用相对路径指定文件或目录，相对于 .gitignore 文件的位置。
- 如果 .gitignore 文件位于子目录中，路径会根据 .gitignore 文件的位置进行计算。
以斜杠开头的路径（绝对路径）
- 如果路径以 / 开头，表示该文件或目录是相对于 Git 仓库的根目录进行匹配的。
- 例如，/config 只会忽略根目录下的 config 文件夹，而不是子目录中的 config 文件夹。
排除规则
- 使用 ! 来取消之前的忽略规则（反向匹配）。
- 例如，*.log 会忽略所有 .log 文件，但如果你希望某个特定的 .log 文件被 Git 跟踪，可以写 !important.log 来排除该文件。

2.3 常见的模式

*.log：忽略所有 .log 文件。
node_modules/：忽略 node_modules 文件夹，通常用于前端项目中，存放了所有依赖库。
*.class：忽略 Java 编译时生成的 .class 文件。
debug/：忽略 debug 文件夹，通常是某些工具生成的临时文件夹。
*.bak：忽略所有以 .bak 为后缀的备份文件。
*.swp：忽略 Vim 编辑器生成的临时交换文件。

3. .gitignore 常见示例

3.1 JavaScript/Node.js 项目的 .gitignore 示例

在 Node.js 项目中，通常需要忽略一些依赖文件和编译产物。例如：

# 忽略 node_modules 文件夹
node_modules/
 
# 忽略日志文件
*.log
 
# 忽略临时文件
*.swp
*.bak
 
# 忽略环境配置文件
.env

这个 .gitignore 文件会忽略 Node.js 项目中常见的依赖目录和临时文件。特别是 node_modules/ 目录，它通常包含成千上万的依赖包，不需要加入版本控制。

3.2 Java 项目的 .gitignore 示例

Java 项目通常会生成 .class 文件和 target/ 目录（存放编译后的文件），这些都应该被忽略。

# 忽略编译产生的 .class 文件
*.class
 
# 忽略构建目录 target/
target/
 
# 忽略日志文件
*.log
 
# 忽略 IDE 配置文件
.idea/
.vscode/
 
# 忽略本地配置文件
*.iml

3.3 Python 项目的 .gitignore 示例

Python 项目常常会生成虚拟环境目录（venv/）和一些临时文件。

# 忽略虚拟环境
venv/
 
# 忽略 Python 字节码文件
*.pyc
 
# 忽略 IDE 配置文件
.idea/
.vscode/
 
# 忽略日志文件
*.log

3.4 macOS 和 Windows 系统相关文件

操作系统生成的一些临时文件也可以添加到 .gitignore 中，以避免它们出现在 Git 仓库中。

macOS

# macOS 特定文件
.DS_Store

Windows

# Windows 特定文件
Thumbs.db
Desktop.ini

4. .gitignore 文件的高级技巧

4.1 使用多个 .gitignore 文件

如果项目比较复杂，可能包含多个子模块或文件夹，每个文件夹可能有不同的忽略需求。你可以在每个子文件夹中创建 .gitignore 文件，也可以在根目录中创建一个全局的 .gitignore 文件。

4.2 使用全局 .gitignore

有时候你希望 Git 忽略某些文件而不管你在哪个项目中，可以设置一个全局 .gitignore 文件。例如，忽略所有编辑器的配置文件。通过以下命令，你可以设置一个全局 .gitignore 文件：

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

然后在 ~/.gitignore_global 文件中添加要忽略的文件：

# 忽略编辑器配置文件
*.swp
.idea/
.vscode/

4.3 只忽略特定目录中的文件

使用 **/ 可以忽略任意目录下的特定文件。

# 忽略所有目录下的 .log 文件
**/*.log

5. 总结与最佳实践

5.1 合理配置 .gitignore 文件

根据项目类型选择忽略内容：不同的开发环境和语言会生成不同的文件和目录，确保忽略那些不需要版本控制的文件，例如编译产物、日志文件、依赖库等。
避免忽略重要的文件：不要忽略那些实际对项目有用的文件，例如 .gitignore 配置文件本身、构建脚本等。
使用全局 .gitignore 文件：对于常见的、跨项目的忽略文件，可以使用全局 .gitignore 来统一管理。

5.2 常见误区

忽略规则不会影响已跟踪的文件：如果某个文件已经被 Git 跟踪，即使你在 .gitignore 中添加了相应规则，它也不会被 Git 忽略。此时，你需要手动删除已跟踪的文件，可以使用 git rm --cached 命令。
```
git rm --cached <file>
```
大小写敏感问题：在 .gitignore 中，路径是大小写敏感的。如果你想忽略 README.md 和 readme.md，需要分别指定。

Quartz 4

Explorer