雷达智富

首页 > 内容 > 程序笔记 > 正文

程序笔记

git 无法提交空目录 ? (.gitkeep 文件的作用)

2024-09-20 16

1. git 无法提交空目录?


相信大家在项目中肯定会发现空目录是不会被 git 追踪 (track) 的,但这是为什么呢 ?

因为 git 最初的设计是用来索引文件的,所以 git 只关注文件,不关心目录,但是在有些场景下空目录也需要被追踪的

2. 如何提交一个空目录 ?


git 无法追踪空目录,但当想要追踪一个空目录时,最主流的做法是在这个空目录中新建一个 .gitkeep 文件,这只是一个约定俗成的空目录识别文件名,除了占位识别空目录,没有其他意义,在很多开源项目中的也是使用这个文件名,比如: vue cli 2 中的 static 目录

这个占位文件名不是一定要非是 .gitkeep 才行,换个名字一样可以,但使用 .gitkeep 更加规范,别人一看就知道这是一个空目录,vscode 插件也能将其识别为 git 相关文件,在其文件名前显示 git 图标

是不是觉得这种解决方案感觉有点扯淡,为什么提交不了空目录,一定要放个文件才行

抱着疑惑的态度查找资料,在下面这个链接我找到解释

https://git.wiki.kernel.org/index.php/GitFaq#Can_I_add_empty_directories.3F

翻译后

3. 应用场景


场景1. 当一个空目录想要被 git 追踪,这个目录中的内容也需要被 git 跟踪时

.gitkeep 文件内容可有可无,只是起到一个占位符的作用,使目录能够被 git 提交到远程库

使用场景: 存放静态资源的 static 目录、thinkphp6 框架的 extend 目录

├── extend   └── .gitkeep

场景2. 当一个空目录想要被 git 追踪,这个目录中的内容不需要被 git 跟踪时

使用场景: thinkphp6 框架的 runtime 目录

└── runtime    └── .gitignore

.gitignore 文件内容 (忽略目录下的所有内容,但是不忽略 .gitignore):

*!.gitignore
更新于:13天前
赞一波!

文章评论

评论问答