.gitignore
文件是 Git 版本控制系统中一个非常重要的配置文件,用于指定哪些文件或目录应该被 Git 忽略,不纳入版本控制。合理使用 .gitignore
可以避免将临时文件、编译产物、敏感信息等不必要的文件提交到代码仓库中。
1. .gitignore
的基本用法
(1)文件位置
- 通常放在项目的根目录下,文件名为
.gitignore
(注意前面的.
)。 - 也可以放在子目录中,但只对该目录及其子目录生效。
(2)语法规则
语法 | 示例 | 说明 |
---|---|---|
# 开头 | # 这是注释 | 注释行,Git 会忽略 |
* 通配符 | *.log | 忽略所有 .log 文件 |
/ 开头 | /temp | 只忽略根目录下的 temp 文件 |
/ 结尾 | build/ | 忽略 build 目录及其所有内容 |
! 取反 | !important.log | 不忽略 important.log (即使匹配前面的规则) |
** 递归匹配 | **/node_modules/ | 递归忽略所有 node_modules 目录 |
2. 常见使用场景
(1)忽略操作系统自动生成的文件
# macOS
.DS_Store
._*# Windows
Thumbs.db
Desktop.ini
(2)忽略 IDE/编辑器临时文件
# VS Code
.vscode/
*.code-workspace# IntelliJ IDEA
.idea/
*.iml
*.iws
(3)忽略 Node.js 依赖和缓存
# Node.js
node_modules/
npm-debug.log*
yarn-error.log
(4)忽略 Python 虚拟环境和编译文件
# Python
__pycache__/
*.py[cod]
venv/
(5)忽略构建产物
# Java
target/
*.class
*.jar# C/C++
*.o
*.out
*.exe
(6)忽略敏感信息
# 配置文件(如 API 密钥、数据库密码)
.env
config.yml
secrets/