.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/