你了解 .gitkeep文件吗？

目录

简介

作用

例程

---

简介

本文主要介绍在git中, .gitkeep的作用。

作用

git无法追踪一个空的文件夹，当用户需要追踪(track)一个空的文件夹的时候，按照惯例，大家会把一个称为.gitkeep的文件放在这些文件夹里。

例程

就个人而言，一般需要.gitkeep地方，是希望完成以下功能：

• 使git忽略一个文件夹下的所有文件，并保留该文件夹

# .gitignore 

# ignore all files in lib/
lib/*
# except for .gitkeep
!.gitkeep
# ignore TODO file in root directory,not subdir/TODO
/TODO

当.gitignore采用上面的写法时，git会忽略lib文件夹下除了.gitkeep外的所有文件。如果没有.gitignore文件，则lib就是一个空文件夹，不会被git所跟踪，因为git不允许追踪一个空的文件夹。

大家可能在很多的开源项目中都看到过.gitkeep这个文件，文件内没有任何内容，一个空空的文件。

那么，它的作用到底是什么呢？

这要从git不允许追踪(track)或者说提交一个空的文件夹说起，git本身是不允许提交一个空文件夹的，所有就有了.gitkeep的存在，可以把它看作是一个占位符，当然了，你也可以使用 .nofile、please.delete.me或者其他的占位符，自行决定。

当然了，虽说.gitkeep只是约定俗成的一个名称，但是业内人员已经习惯使用.gitkeep，已经达成了共识，所以我们尽量还是使用.gitkeep。

---

相关参考

如何用GitKeep提交和推送一个文件夹

如何使用win命令行创建.gitkeep文件

何为.gitkeep以及.gitkeep文件的作用