在我们做项目的过程中,需要用到git进行项目的管理。以下几点是我在使用git写项目的过程中总结出来需要注意的问题。
问题一:git中的README.md目录如何可以自动生成文件树结构?
答:我们先来解释下为什么要在README.md文件中生成文件树结构,主要是为了对当前项目做解释说明,让项目的结构清晰,一目了然。
如果我们使用vscode编辑器,方法如下:
(1) 点击vscode的终端按钮,选择新建终端
(2)我们可以发现当前所在位置是我们当前项目的目录,在项目目录下输入: tree /f > README.md
(3)我们再次打开新生成的README.md文件,可以发现树目录结构已经自动生成。此命令表示:使用/f参数时显示目录及目录下的所有文件。省略时,只显示目录,不显示目录下的文件。
其实我们也可以在cmd命令行中,输入指令进行同样的操作。
(1) windows+R按键,打开cmd命令工具
(2)进入到当前项目所在的文件夹中,输入:tree /f > README.md
(3)打开目录中的文件,我们会发现README.md乱码了。
当我尝试用此方法的时候,乱码的问题让我找不到好的解决办法,最终发现如果我们启用超级管理员的方式,再次输入命令的时候,就可以正确编码,README.md中出现正确的树结构。
问题:那么我们该如何启用超级管理员权限呢?
(1)首先,我们依旧是windows+R按钮,在此处输入powershell
(2)点击确定之后,我们会进入如下界面
(3)与上述步骤一样,进入到项目所在的文件夹中,输入:tree /f > README.md
(4)打开README.md文件,我们发现树目录可以正确解析了。
拓展:
除此之外我们还有其他的参数可以设置。
命令行 效果
tree -d 只显示文件夹
tree -D 显示文件的最后修改时间
tree -L n n表示显示项目的层级,n=3即只显示项目的三层结构
tree -l pattern表示想要过滤的目录,例如:tree -l"node_modules"可以过滤掉
pattern node_modules这个文件夹
注意:这里的参数-d、-D区分大小写,大家可以自行实验。
问题二:我们提交了代码至git上,但是发现空的文件夹没有出现在git中,为什么会出现这个问题?
总之,我们需要知道的是git不支持空文件夹的提交。那么我们该如何提交这些空的文件夹呢?
在网上找了很多资料,我们会发现有一个.gitkeep文件,这个文件是干什么用的呢?我们该如何创建它呢?
1.什么是.gitkeep?
.gitkeep是一个约定俗成的文件名并没有什么特殊规则,它就相当于一个占位,0字节。
2.它有什么用呢?
当你提交代码的时候,目录中有空文件夹的时候,git会自动忽略掉,而有时候你就想留着这个空目录,以后想添加文件不想被忽略,这个时候就可以创建一个.gitkeep空文件,把它提交上去即可~
3.我们该如何创建.gitkeep文件呢?
通常我们会保存一份.gitkeep文件,内容为空即可,用到的时候只要复制粘贴就好了。
4.如果这个文件弄丢了,该怎么办呢?
我们可以通过命令来自动生成.gitkeep文件。
步骤如下:
(1)打开cmd命令行,或者git bash (vscode的终端也可以)
(2)切换到需要生成.gitkeep文件的目录下面,用命令输入:type null >.gitkeep.
问题三:在使用git的过程中,我们喜欢有的文件比如日志,临时文件,编译的中间文件等不要提交到代码仓库,这时就要设置相应的忽略规则,来忽略这些文件的提交,该如何操作呢?
注明:此解决方法是参照攻城狮--王伟desire(简书)的文章来完成的,所以非常感谢原作者的无私分享。
git忽略文件提交的方法:
规则 作用:
(1) /mtk 过滤整个文件夹;
(2) *.zip 过滤所有.zip文件;
(3) /mtk/do.c 过滤某个具体文件;
(4) !/mtk/one.txt 追踪(不过滤)某个具体文件;
注意:如果你创建.gitignore文件之前就push了某一文件,那么即使你在.gitignore文件中写入过滤该文件的规则,该规则也不会起作用,git仍然会对该文件进行版本管理。
配置语法:
(1) 以斜杠"/"开头表示目录;
(2) 以星号"*"通配多个字符;
(3) 以问号"?"通配单个字符;
(4) 以方括号"[]"包含单个字符的匹配列表;
(5) 以叹号"!"表示不忽略(跟踪)匹配到的文件或目录;
注意: git 对于 .gitignore配置文件是按行从上到下进行规则匹配的
有三种方法可以实现忽略git中不想提交的文件。
(1)在git项目中定义.gitignore文件
这种方式通过在项目的某个文件夹下定义.gitignore文件,在该文件中定义相应的忽略规则,来管理当前文件夹下的文件的git提交行为。
.gitignore文件是可以提交到共有仓库中,这就为该项目下的所有开发者都共享一套定义好的忽略规则。
在.gitignore文件中,遵循相应的语法,在每一行指定一个忽略规则。如:
*.log
*.temp
/vendor
(2)在git项目的设置中指定排除文件
这种方式只是临时指定该项目的行为,需要编辑当前项目下的.git/info/exclude文件,然后将需要忽略提交的文件写入其中。
需要注意的是,这种方式指定的忽略文件的根目录是项目根目录。
(3)定义git全局的.gitignore文件
除了可以在项目中定义.gitignore文件外,还可以设置全局的git .gitignore文件来管理所有git项目的行为。这种方式在不同的项目开发者之间是不共享的,是属于项目之上git应用级别的行为。
这种方式也需要创建相应的.gitignore文件,可以放在任意位置。然后在使用以下命令配置git:
git config --global core.excludesfile ~/.gitignore
简而言之,git中写入.gitingore文件是最好的解决方法之一。
git忽略规则匹配语法:
在 .gitignore 文件中,每一行的忽略规则的语法如下:
(1) 空格不匹配任意文件,可作为分隔符,可用反斜杠转义;
(2) # 开头的模式标识注释,可以使用反斜杠进行转义;
(3) ! 开头的模式标识否定,该文件将会再次被包含,如果排除了该文件的父级目录,则使用 ! 也不会再次被包含。可以使用反斜杠进行转义;
(4) / 结束的模式只匹配文件夹以及在该文件夹路径下的内容,但是不匹配该文件;
(5) / 开始的模式匹配项目根目录;
(6) 如果一个模式不包含斜杠,则它匹配相对于当前 .gitignore 文件路径的内容,如果该模式不在
(7) .gitignore 文件中,则相对于项目根目录;
(8) **匹配多级目录,可在开始,中间,结束;
(9) ?通用匹配单个字符;
(10) []通用匹配单个字符列表;
常用匹配示例:
(1) bin/: 忽略当前路径下的bin文件夹,该文件夹下的所有内容都会被忽略,不忽略 bin 文件;
(2) /bin: 忽略根目录下的bin文件;
(3) /*.c: 忽略 cat.c,不忽略 build/cat.c;
(4) debug/*.obj: 忽略 debug/io.obj,不忽略 debug/common/io.obj 和 tools/debug/io.obj;
(5) **/foo: 忽略/foo, a/foo, a/b/foo等;
(6) a/**/b: 忽略a/b, a/x/b, a/x/y/b等;
(7) !/bin/run.sh: 不忽略 bin 目录下的 run.sh 文件;
(8) *.log: 忽略所有 .log 文件;
(9) config.php: 忽略当前路径的 config.php 文件;
.gitignore规则不生效
.gitignore只能忽略那些原来没有被track的文件,如果某些文件已经被纳入了版本管理中,则修改.gitignore是无效的。
解决方法就是先把本地缓存删除(改成未track状态),然后再提交:
git rm -r --cached .
git add .
git commit -m 'update .gitignore'