一个小型实用程序,用于强制将空目录放入git repo。
gitkeep2的Python项目详细描述
GitKeep
有时在使用Git时,您需要将空文件夹作为 储存库。也许是因为你想在 某些目录对于将来存储某些文件的重要性。 也许逻辑的某些部分取决于那里的目录。
但是,因为git只会版本文件,所以它是unable to add empty directories 。
解决这个问题的一个众所周知的方法是在 要添加到存储库中的空目录,以便强制 进入源代码管理的目录。
GitKeep是一个用Python编写的小型命令行实用程序,它使
通过在您选择的目录中创建.gitkeep
文件,使用此黑客攻击。
在Bash命令行中,它相当于运行:
find . -type d -empty -exec touch {}/.gitkeep \;
但是,使用上面的bash命令会强制您对每个目录执行相同的操作 要版本的路径,然后手动删除任何异常。
另外,Windows用户没有Bash命令行的功能,除非他们 安装Cygwin
安装
如果已经安装了python,只需运行:
pip3 install gitkeep2
使用
在名为“foo”的特定目录中创建.gitkeep
文件:
gitkeep path/to/foo
向您的.gitkeep
文件中添加消息,以便让其他开发人员
理解为什么在源代码管理中保留指定的目录很重要
您可以使用--message
或-m
标志:
gitkeep path/to/foo -m "This is where we'll later add X stuff."
默认情况下,所有.gitkeep
文件都带有创建日期,指向
项目和默认消息。这里的想法是帮助其他人保持
项目在未来了解这些文件是什么。不过,如果你愿意的话
要创建空的.gitkeep
文件,可以使用--empty
或-e
标志:
gitkeep path/to/foo -e
要从指定路径中删除.gitkeep
文件,请使用--let-go
或-l
标志:
gitkeep --let-go path/to/foo
在路径及其所有子目录中递归创建.gitkeep
文件
使用--recursive
或-r
标志:
gitkeep --recursive path/to/foo
递归地从路径及其所有
子目录使用上面的-r
和-l
标志的组合:
gitkeep -lr path/to/foo
实施说明
GitKeep由Click提供支持。
开发
首先准备一个虚拟环境来安装本地副本从根本上 您的项目运行:
virtualenv venv
New python executable in venv/bin/python
Installing setuptools, pip............done.
激活相应的环境。在OS X和Linux上,请执行以下操作:
. venv/bin/activate
请注意,shell的提示已更改为显示活动环境。
在虚拟环境中安装单击:
pip3 install Click
要在虚拟环境中安装gitkeep,请执行以下操作:
pip3 install --editable .
然后试着运行gitkeep:
gitkeep --help
要回到现实世界,请运行:
deactivate