如何编写.gitignore文件

前端架构师教你如何编写.gitignore文件

.gitignore文件简介

.gitignore文件是Git版本控制系统中一个非常有用的工具。它可以指定一组文件或目录，这些文件或目录将被Git忽略，不会纳入版本控制。这对于避免提交临时文件、构建产物、敏感配置信息等非常有用。

.gitignore文件的语法规则

1. 忽略文件或目录

在.gitignore文件中，每行可以指定一个模式。模式可以是文件名、目录名，也可以是使用通配符的模式。例如：

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

# 忽略名为temp的目录
temp/

2. 使用通配符

• * 匹配任意数量的字符，但不包括目录分隔符/。
• ** 匹配任意数量的字符，包括目录分隔符/，用于递归匹配。
• ? 匹配单个字符。
• [abc] 匹配括号内任一字符。

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

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

# 忽略a.out, b.out等
*.out

[]用的比较少，因为.gitignore不支持复杂写法

# 忽略所有以a、b或c开头的.txt文件
[abc].txt

这意味着Git将忽略任何文件名恰好为a.txt、b.txt或c.txt的文件，但不会忽略d.txt或其他不以a、b、c之一开头的.txt文件。

需要注意的是，这个模式只匹配单个字符。如果你想匹配多个字符中的任意一个，你需要使用其他模式，比如*通配符来匹配任意数量的任意字符，或者使用?来匹配任意单个字符。

举个例子，如果你想忽略所有以a、b或c开头，并且扩展名为.log的文件，你应该这样写：

[abc]*.log

但这个模式实际上是错误的，因为它会尝试匹配以a、b或c开头，后面跟着任意数量的任意字符，再后面是.log的文件。正确的模式应该是使用**来递归匹配任意数量的目录和文件名，如下：

**[abc]*.log

但这个模式也是不正确的，因为它会尝试匹配包含a、b或c任意位置的.log文件。实际上，Gitignore的模式并不支持这种复杂的字符类与通配符的结合。要实现这个需求，你可能需要为每个情况单独写一行：

a*.log
b*.log
c*.log

或者，如果你的意图是忽略所有扩展名为.log的文件，不论它们是否以a、b或c开头，你只需要简单地写：

*.log

请确保你理解你的.gitignore模式实际上是如何工作的，以避免意外的文件被忽略或未被忽略。

3. 锚定模式

如果模式的开头或结尾包含目录分隔符/，则模式仅匹配以该目录分隔符开头或结尾的路径。

# 只忽略项目根目录下的TODO文件
/TODO

# 忽略所有目录下的build目录
build/

# 忽略所有以.html结尾的文件，但不忽略在子目录中的
/*.html

4. 否定模式

以!开头的模式表示否定，即不被忽略。否定模式可以覆盖之前的忽略模式。

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

# 但不忽略lib.a
!lib.a

5. 注释

使用#开头的行作为注释，Git会忽略这些行。

.gitignore文件的最佳实践

1. 为项目类型定制

不同类型的项目有不同的临时文件和构建产物。例如，Node.js项目可能有node_modules目录，而Python项目可能有.pyc文件。因此，.gitignore文件应该根据项目的类型进行定制。

Node.js项目的.gitignore示例：

# 依赖目录
node_modules/

# 日志文件
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# 编译产物
dist/
build/

2. 忽略敏感信息

永远不要将包含敏感信息的文件（如密码、密钥等）纳入版本控制。确保在.gitignore文件中添加这些文件。

# 忽略敏感配置文件
config/secret.json
*.env

3. 使用公共模板

对于常见的项目类型，可以在GitHub上找到许多公共的.gitignore模板。例如，创建新项目时，可以在GitHub的仓库创建页面选择适当的模板。

4. 共享通用规则

如果多个项目使用相同的.gitignore规则，可以考虑将这些规则放在一个通用的文件中，并使用Git的子模块功能来共享。

5. 注意否定模式的顺序

由于否定模式可以覆盖之前的忽略模式，因此需要注意它们的顺序。通常，更具体的模式应该放在更通用的模式之前。

常见问题与解决

1. 我已经提交了不应该被追踪的文件，怎么办？

   首先，更新.gitignore文件以忽略这些文件。然后，使用git rm --cached 命令从Git的追踪中移除它们，但不从文件系统中删除。最后，提交更改。

2. 为什么Git没有忽略我指定的文件？

   • 确保.gitignore文件位于正确的位置（通常是项目的根目录）。
   • 检查.gitignore文件的语法是否正确。
   • 如果文件已经被Git追踪，.gitignore不会对其生效。需要先停止追踪该文件。

3. 我应该将.gitignore文件纳入版本控制吗？

   是的，通常应该将.gitignore文件纳入版本控制。这样，其他开发者可以共享相同的忽略规则。

总结

.gitignore文件是Git版本控制中不可或缺的一部分，它帮助我们保持仓库的整洁，避免敏感信息泄露，以及减少不必要的冲突。通过本文的介绍，你应该已经掌握了编写.gitignore文件的基本语法和最佳实践，并能够解决常见问题。记住，好的.gitignore文件是团队协作的基石之一。