你可能不知道的gitignore生成器
提前.gitignore相信大家并不陌生,我们在github上看到的优秀的开源软件几乎都有这个文件,那么这个文件是做啥的呢?我们该如何编写?需要依据什么样的标准?有木有文档可以参考下?那么接下来我就为大家简单介绍下
为什么会存在.gitignore
日常问题
•团队协同过程中,你是否被吐槽过为什么.pyc
或者.env
文件也上传到代码仓库了,.env
里面有可能涉及到个人的一些敏感的账号密码之类的,.pyc
这类文件被人在代码仓库里看到,会给人一种很不专业的感觉•令人讨厌的__MACOSX文件夹等等临时目录
原来你是如何编写.gitignore呢
•最开始写.gitignore你是不是仿照这别人的代码仓库复制一份呢•或者自己手写一个最精简版本的•也可能以上两种方式都不是
那么有木有比较便捷而且规范的方式呢
我可以非常肯定的告诉你,有,那就是我们今天要介绍的gitignore.io[1]
gitignore.io
今天我们为什么要提这个工具呢,那是因为在我个人角度来看,这个工具真的是神器,360度满足你的所需,为什么这么说呢,那是因为以下几个理由,相信你看了以下几点,你也会为他的强大而折服
平台支持
•源码开源•win•mac•*nix
使用方式支持
这才是最让人服气的,你习惯命令行的话,可以用命令行,你想用客户端,那就安装客户端,你想要本地部署的话,直接docker启动即可。
•在线版本gitignore.io[2]•支持命令行 cli[3]•支持客户端 client[4]•支持api api[5]•支持本地部署server server[6]
我们着重介绍下客户端
这里我们选用python的客户端和命令行别名实现为大家演示下效果,是否如同我上面说的那么让人惊叹
python客户端
命令行别名实现
注意事项
网络问题
需要注意一点,甭管是客户端还是命令行都是需要和https://www.toptal.com/developers/gitignore进行通信的,如果网络不好的情况下,很可能会出现502的情况,重新执行下就好了,建议还是本地架设服务器吧
局限性
客户端的支持力度较弱(这里说的是python的客户端,我个人平时python用的比较多),而且不支持多种语言一块查询生成,推荐大家架设本地服务器,然后使用命令行别名的方式实现,如果有能力的话,可以重新封装下客户端。
编外话
如果你真的对gitignore.io一点都不感冒,那也没关系,github上同样有一个拥有103k
star的代码仓库,包揽了99%的当前市面上的需求,你也可以尝试下这个,地址是
github-gitignore[7]
总结
相信大家在日常的技术交流群或者公司内部的部门群里也会有提到,哎你这个仓库为啥没有.gitignore啊,不专业啊,为啥要上传配置文件啊,为啥要上传sqlite3.db文件啊,等等之类的话题,用来这个工具,既能保障代码仓库的干净又能无形中装逼,赶紧用起来吧。
欢迎关注我的公众号“追马Linux”,原创技术文章第一时间推送。
引用链接
[1]
gitignore.io: https://www.toptal.com/developers/gitignore[2]
gitignore.io: https://www.toptal.com/developers/gitignore[3]
cli: https://docs.gitignore.io/install/command-line[4]
client: https://docs.gitignore.io/install/client-applications[5]
api: https://docs.gitignore.io/use/api[6]
server: https://docs.gitignore.io/install/local-server[7]
github-gitignore: https://github.com/github/gitignore