Gitignore配置

1. .gitignore 概述

1.1 为什么需要 .gitignore

.gitignore 指定 Git 应该忽略的文件和目录，避免将不必要的文件纳入版本控制。

1.2 应该忽略的文件类型

2. 语法规则

2.1 基本语法

# 注释以 # 开头

# 忽略所有 .log 文件
*.log

# 忽略整个目录
node_modules/
build/

# 忽略特定文件
.env
config.local.json

# 使用 ! 取反（不忽略）
!important.log

# 只忽略根目录的文件
/TODO

# 忽略所有目录中的文件
**/temp/

2.2 Glob 模式

2.3 优先级规则

• 后面的规则覆盖前面的
• ! 取反优先级低于忽略
• 父目录被忽略后，子目录的 ! 无效

# 忽略所有 .js 文件
*.js

# 但不忽略 main.js
!main.js

#  如果忽略整个目录，! 不生效
build/
!build/important.js  #  不生效！

3. 多级 .gitignore

3.1 优先级

.gitignore（仓库根目录）
├── src/.gitignore（src 目录）
│   └── src/utils/.gitignore（更深层目录）
└── docs/.gitignore（docs 目录）

优先级：越深层的 .gitignore 优先级越高

3.2 全局 .gitignore

# 设置全局 gitignore
git config --global core.excludesfile ~/.gitignore_global

# ~/.gitignore_global 内容
.DS_Store
.idea/
.vscode/
*.swp
*.swo
*~

4. 常用模板

4.1 Node.js 项目

node_modules/
dist/
build/
.env
.env.local
*.log
coverage/
.nyc_output/

4.2 Python 项目

__pycache__/
*.py[cod]
*.egg-info/
dist/
.venv/
.env
.pytest_cache/
.mypy_cache/

4.3 通用模板

# OS
.DS_Store
Thumbs.db

# IDE
.idea/
.vscode/
*.swp

# 环境
.env
.env.local

# 日志
*.log

5. 已跟踪文件的忽略

5.1 停止跟踪已提交的文件

# 停止跟踪但保留本地文件
git rm --cached .env
git rm --cached -r node_modules/

# 提交
git commit -m "chore: remove tracked files from gitignore"

5.2 忽略已跟踪文件的修改

# 临时忽略修改
git update-index --assume-unchanged config.local.js

# 恢复跟踪
git update-index --no-assume-unchanged config.local.js

# 查看被忽略的文件
git ls-files -v | grep '^h'

6. gitignore 模板库

GitHub 提供了丰富的 gitignore 模板：github/gitignore

# 使用 curl 下载模板
curl -o .gitignore https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore