.gitignore文件使用指南

.gitignore文件使用指南

.gitignore 文件的作用

1. 忽略不需要的文件：避免将不必要的文件（如编译生成的文件、临时文件、日志文件等）提交到代码仓库。
2. 保护敏感信息：防止本地配置文件（如数据库配置文件、API 密钥等）被提交，从而保护敏感信息。
3. 保持代码仓库整洁：只包含源码和必要的配置文件，使代码仓库更加整洁和易于管理。

.gitignore 文件的基本语法

• 注释：以 # 开头的行是注释。
• 空行：空行会被忽略。
• 通配符：使用 * 匹配零个或多个字符，? 匹配单个字符，[] 匹配括号内的任意字符。
• 目录：以斜杠 / 结尾表示目录。
• 否定模式：以 ! 开头表示不忽略匹配的文件或目录，即使它们的父目录被忽略。

示例 .gitignore 文件

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

# 忽略所有 .DS_Store 文件（Mac OS）
.DS_Store

# 忽略 node_modules 目录
node_modules/

# 忽略编译生成的文件
dist/
build/

# 忽略环境配置文件
.env
.env.local

# 忽略特定的文件
secret.json

# 不忽略某个特定文件
!important.txt

# 忽略所有 .txt 文件，但不忽略 doc.txt
*.txt
!doc.txt

如何创建和维护 .gitignore 文件

创建 .gitignore 文件：

在项目的根目录下创建一个名为 .gitignore 的文件。

添加忽略规则：

根据项目的需要，添加相应的忽略规则。例如，如果你使用的是 Node.js 项目，可能会忽略 node_modules 目录和环境变量文件 .env。

提交 .gitignore 文件：

将 .gitignore 文件添加到 Git 仓库中并提交：

git add .gitignore
git commit -m "Add .gitignore file"