不写 '.gitignore'（提交 '.env'、'dist/'、'.DS_Store'）

不写 '.gitignore'（提交 '.env'、'dist/'、'.DS_Store'）的后果

.gitignore 文件是 Git 版本控制中一个非常重要的配置文件，它用于指定哪些文件或目录不应该被纳入版本控制。如果不写 .gitignore 文件，会导致一些敏感信息、临时文件或编译产物被提交到代码仓库中，这可能会带来一系列问题。

敏感信息泄露

.env 文件通常用于存储环境变量，比如数据库密码、API 密钥等敏感信息。如果不将 .env 添加到 .gitignore 中，这些信息会被提交到代码仓库中，任何人都可以查看。

// .env 示例
DB_PASSWORD=mysecretpassword
API_KEY=1234567890abcdef

一旦这些信息被泄露，可能会导致数据库被入侵、API 被滥用等安全问题。即使后续从 Git 历史中删除这些文件，它们仍然可以通过 Git 的历史记录被恢复。

编译产物污染仓库

dist/ 目录通常是前端项目的编译输出目录，包含了经过打包和压缩后的代码。这些文件是由源代码生成的，不应该被纳入版本控制。

# 不写 .gitignore 的情况下，dist/ 会被提交
git add dist/
git commit -m "Add dist files"

提交 dist/ 会导致仓库体积迅速膨胀，尤其是在频繁构建的情况下。此外，如果多人协作，可能会因为不同开发者的构建环境不同而导致 dist/ 中的文件冲突。

系统文件混入仓库

.DS_Store 是 macOS 系统生成的隐藏文件，用于存储文件夹的自定义属性（如图标位置、背景等）。如果不忽略这类文件，它们会被提交到仓库中。

# 查看未忽略的 .DS_Store 文件
git status
# 输出可能包含：
# Untracked files:
#   .DS_Store

这些文件对项目毫无意义，而且会因为不同开发者的系统环境不同而产生不必要的差异。更糟糕的是，如果多个开发者使用不同的操作系统，可能会导致 .DS_Store 文件频繁冲突。

如何正确配置 .gitignore

为了避免上述问题，应该在项目根目录下创建 .gitignore 文件，并添加需要忽略的文件和目录。以下是一个典型的前端项目 .gitignore 示例：

# 环境变量文件
.env
.env.local
.env.*.local

# 编译输出目录
dist/
build/
out/

# 系统文件
.DS_Store
Thumbs.db

# 依赖目录
node_modules/

# 日志文件
*.log

补救措施

如果已经不小心提交了不该提交的文件，可以通过以下步骤从 Git 历史中彻底删除它们：

1. 从工作目录中删除文件：

   git rm --cached .env
   git rm --cached -r dist/
   git rm --cached .DS_Store
   

2. 提交删除操作：

   git commit -m "Remove sensitive files"
   

3. 如果需要从历史中彻底清除（注意：这会重写历史）：

   git filter-branch --force --index-filter \
     "git rm --cached --ignore-unmatch .env dist/ .DS_Store" \
     --prune-empty --tag-name-filter cat -- --all
   

自动化工具

可以使用工具自动生成适合项目的 .gitignore 文件。比如：

• gitignore.io 可以根据项目类型生成 .gitignore
• 对于 Node.js 项目，可以使用 npx gitignore node 命令

团队协作中的注意事项

在团队开发中，.gitignore 应该被视为项目的基础配置文件之一，需要和 package.json 一样被纳入版本控制。新成员加入项目时，应该第一时间检查 .gitignore 是否完整，避免因个人疏忽提交不该提交的文件。

CI/CD 中的额外检查

为了确保万无一失，可以在持续集成流程中添加检查步骤，防止敏感文件被意外提交。例如，在 GitHub Actions 中可以添加如下检查：

name: Check for sensitive files

on: [push]

jobs:
  check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Check for .env files
        run: |
          if [ -f .env ]; then
            echo "Error: .env file detected!"
            exit 1
          fi

编辑器与 IDE 的临时文件

除了上述常见文件外，不同的编辑器和 IDE 也会生成临时文件或项目特定文件，这些也应该被忽略。例如：

# VS Code
.vscode/
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json

# JetBrains IDE
.idea/
*.iml
*.ipr

# Vim
*.swp
*.swo

性能影响

不正确的 .gitignore 配置会影响 Git 的性能。Git 需要检查每个文件的忽略状态，如果忽略规则不完善，Git 会不必要地跟踪大量文件，导致操作变慢。特别是在大型项目中，正确的 .gitignore 可以显著提高 git status、git add 等命令的速度。

特殊情况处理

有时候，你可能需要忽略某个目录下的特定文件，但不忽略其他文件。这时可以使用负向规则：

# 忽略所有 tests 目录下的 .tmp 文件
tests/**/*.tmp

# 但不忽略 tests/utils/.tmp
!tests/utils/.tmp

全局 .gitignore

除了项目特定的 .gitignore，还可以设置全局的 .gitignore 文件，用于忽略所有项目中的通用文件（如 .DS_Store）。设置方法：

git config --global core.excludesfile ~/.gitignore_global

然后在 ~/.gitignore_global 中添加通用规则。但要注意，全局配置不应该包含项目特定的忽略规则。