Feb 21, 2025

gitignore 用法

在写代码的时候发现 .gitignore 文件是项目文件中不可缺少的一环，于是写一份教程笔记。也算是 Git 教程的番外篇吧。

.gitignore 文件用于告诉 Git 哪些文件或目录应该被忽略，不纳入版本控制。它常用于排除编译产物、临时文件、日志、敏感信息（如密码或密钥）等。

在项目根目录下创建 .gitignore 文件（文件名固定，不可更改）。

* 通配符：匹配任意字符（除路径分隔符）。

*.log       # 忽略所有 .log 文件
temp-*.txt  # 忽略 temp- 开头的 .txt 文件

/ 目录前缀：仅匹配当前目录下的文件或目录，当前是重点。

# /build 忽略根目录下的 hello 目录，但不忽略子目录中的 hello
project-path
├── hello
└── test              [❌]
    └── hello         [✅]

# logs/ 忽略所有名为 logs 的目录及其内容
project-path
├── logs              [❌]
└── logs              [✅]
    └── log.txt

** 递归匹配：匹配任意层级的目录。

# **/temp 忽略所有目录下的 temp 文件或目录
project-path
├── temp              [✅]
└── test
    └── temo          [✅]

? 单字符匹配：匹配单个任意字符。

# file?.txt 忽略 file1.txt、fileA.txt 等
project-path
├── file1.txt         [✅]
├── fileA.txt         [✅]
└── fileABC.txt       [❌]

! 前缀：排除某个已忽略的文件。

# *.log 忽略所有 .log 文件
# !error.log 但保留 error.log
project-path
├── operation.log       [✅]
└── error.log           [❌]

# 忽略编译产物
*.class
*.exe
*.dll

# 忽略日志文件
*.log

# 忽略 node_modules 目录
node_modules/

# 忽略所有 build 目录
build/

# macOS 系统文件
.DS_Store

# Windows 系统文件
Thumbs.db

# JetBrains IDE 配置
.idea/
*.iml

# VSCode 配置
.vscode/

# 配置文件中的密钥或密码
config/secrets.yml
.env

配置全局 .gitignore 文件（适用于所有项目）：

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

若文件已被 Git 跟踪（已提交过），即使添加到 .gitignore 仍会被追踪。需手动删除缓存：
```
git rm --cached <file>  # 从版本库移除，保留本地文件
git commit -m "Remove ignored files"
```