如何编写.gitignore文件

简介: 如何编写.gitignore文件

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

.gitignore文件简介

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

.gitignore文件的语法规则

  1. 忽略文件或目录

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

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

# 忽略名为temp的目录
temp/
  1. 使用通配符
  • * 匹配任意数量的字符,但不包括目录分隔符/
  • ** 匹配任意数量的字符,包括目录分隔符/,用于递归匹配。
  • ? 匹配单个字符。
  • [abc] 匹配括号内任一字符。
# 忽略所有.txt文件
*.txt

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

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

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

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

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

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

举个例子,如果你想忽略所有以abc开头,并且扩展名为.log的文件,你应该这样写:

[abc]*.log

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

**[abc]*.log

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

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

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

*.log

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

  1. 锚定模式

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

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

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

# 忽略所有以.html结尾的文件,但不忽略在子目录中的
/*.html
  1. 否定模式

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

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

# 但不忽略lib.a
!lib.a
  1. 注释

使用#开头的行作为注释,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/
  1. 忽略敏感信息

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

# 忽略敏感配置文件
config/secret.json
*.env
  1. 使用公共模板

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

  1. 共享通用规则

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

  1. 注意否定模式的顺序

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

常见问题与解决

  1. 我已经提交了不应该被追踪的文件,怎么办?
  2. 首先,更新.gitignore文件以忽略这些文件。然后,使用git rm --cached <file>命令从Git的追踪中移除它们,但不从文件系统中删除。最后,提交更改。
  3. 为什么Git没有忽略我指定的文件?
  • 确保.gitignore文件位于正确的位置(通常是项目的根目录)。
  • 检查.gitignore文件的语法是否正确。
  • 如果文件已经被Git追踪,.gitignore不会对其生效。需要先停止追踪该文件。
  1. 我应该将.gitignore文件纳入版本控制吗?
    是的,通常应该将.gitignore文件纳入版本控制。这样,其他开发者可以共享相同的忽略规则。

总结

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

相关文章
|
1月前
|
SQL 缓存 IDE
Spingboot项目解决.gitignore文件不起作用的问题
【10月更文挑战第15天】在使用 Git 时,有时会遇到 `.gitignore` 文件不起作用的情况。这通常是因为要忽略的文件或文件夹已经被添加到仓库中。解决方法是先将这些文件从缓存中移除,再重新提交。具体操作如下: 3. 运行 `git add .`。 4. 运行 `git commit -m "fixed files"`。 这样就可以成功忽略指定的文件或文件夹。
134 58
|
2月前
|
程序员 开发工具 Android开发
代码审查|这段代码,为什么复制文件夹总是“成功”?
最近开始一个人负责整个项目的全栈开发和维护,工作中没了和同事交叉 code review 的环节,所以就打算,如果工作中遇到一些比较典型的代码,包括好味道和坏味道,就拿出来分析下,与大家一起交流,作为另一种形式的「交叉 review」。
28 1
|
7月前
|
前端开发
.gitignore文件讲解并附带常用忽略代码
.gitignore文件讲解并附带常用忽略代码
|
缓存 IDE 编译器
Git文件.gitignore和.gitkeep用法解析
Git文件.gitignore和.gitkeep用法解析
642 0
|
Java 开发工具 git
.gitignore忽略文件如何配置
.gitignore忽略文件如何配置
|
开发工具 Android开发 iOS开发
给Flutter项目添加.gitignore文件以及如何修改.gitignore文件并生效
flutter项目的开发,一般来说都是与原生开发混合进行的,单纯的flutter开发局限性很大,需要与原生进行配合。
|
存储 Java 开发工具
Git文件.gitignore、.gitattributes、.gitkeep用法解析
.gitignore、.gitattributes、.gitkeep都是常见的Git相关文件,本文介绍它们到底该如何使用。
821 0
|
开发工具 git
.gitignore的用法详解
在 .gitingore 文件中,每一行指定一个忽略规则,Git 检查忽略规则的时候有多个来源,
216 0
.gitignore文件不生效
.gitignore文件不生效
150 0
|
Shell Linux C语言
Makefile文件 | 编写指南
Makefile文件 | 编写指南
334 0