【Git】如何添加和更新.gitignore文件

【Git】如何添加和更新.gitignore文件

背景

在Git项目中，经常会有一些文件我们不希望被版本控制系统追踪，例如：

• IDE配置文件（.idea/、.vscode/等）
• 操作系统生成的文件（.DS_Store等）
• 编译生成的文件（.class、.jar等）
• 依赖文件目录（node_modules/等）
• 个人配置文件（.obsidian/等）

这时我们需要使用.gitignore文件来告诉Git忽略这些文件。

操作步骤

1. 创建.gitignore文件

在项目根目录下创建.gitignore文件，添加需要忽略的文件规则。以下是一个常用的.gitignore文件模板：

# macOS system files
.DS_Store
.AppleDouble
.LSOverride
Icon
._*

# IDE - IntelliJ IDEA
.idea/
*.iml
*.iws
*.ipr
out/
.idea_modules/

# IDE - VSCode
.vscode/
*.code-workspace

# Obsidian files
.obsidian/

# Compiled files
*.class
*.jar
*.war
*.ear
*.zip
*.tar.gz
*.rar

# Logs and databases
*.log
*.sqlite
*.db

# Node
node_modules/
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# Python
__pycache__/
*.py[cod]
*$py.class
.Python
env/
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
*.egg-info/
.installed.cfg
*.egg

# Temporary files
*.swp
*.swo
*~

2. 清除Git缓存

如果有些文件已经被Git追踪，仅仅添加.gitignore文件是不够的，需要先清除Git缓存：

# 删除Git缓存（不会删除实际文件）
git rm -r --cached .

3. 添加新的.gitignore文件

# 添加.gitignore文件到Git
git add .gitignore

# 添加其他文件
git add .

4. 提交更改

# 提交更改
git commit -m "Add .gitignore file and remove ignored files from git"

5. 推送到远程仓库

# 推送到远程仓库
git push origin master  # 或者其他分支名

注意事项

1. .gitignore只能忽略那些原来没有被追踪的文件，如果某些文件已经被纳入了版本管理中，则修改.gitignore是无效的。
2. 如果需要忽略已经被追踪的文件，必须先删除本地缓存，然后提交。
3. .gitignore文件本身应该被提交到版本库中。
4. 规则匹配说明：
   • # 表示注释
   • * 表示任意多个字符
   • ? 表示任意单个字符
   • [] 表示单个字符的匹配列表
   • ! 表示不忽略匹配到的文件或目录
   • / 结尾表示目录
   • / 开头表示根目录

常见问题

1. Q: 修改.gitignore后为什么还是无法忽略文件？
   A: 可能是因为文件已经被Git追踪，需要清除缓存：git rm -r --cached .

2. Q: 如何忽略文件但保留目录？
   A: 在.gitignore中使用：directory/*，这样会忽略目录中的文件但保留目录本身。

3. Q: 如何忽略特定文件但不忽略某个特定文件？
   A: 使用!符号：

   *.log
   !important.log
   

参考资料

• Git官方文档 - gitignore
• GitHub - gitignore模板