7.4 KiB
_______________________________
( ____ \__ __|__ __( ___ )
| ( \/ ) ( ) ( | ( ) |
| | | | | | | (___) |
| | ____ | | | | | ___ |
| | \_ ) | | | | | ( ) |
| (___) |__) (___ | | | ) ( |
(_______)_______/ )_( |/ \| v0.11
Gita：一个管理多个 git 库的命令行工具
这个工具有两个作用：
- 并排显示多个库的状态信息，比如分支名，编辑状态，提交信息等
- 在任何目录下（批处理）代理执行 git 指令
本地和远程分支之间的关系有5种情况，在这里分别用5种颜色对应着：
- 绿色：本地和远程保持一致
- 红色：本地和远程产生了分叉
- 黄色：本地落后于远程（适合合并merge）
- 白色：本地没有指定远程
- 紫色：本地超前于远程（适合推送push）
为什么选择了紫色作为超前以及黄色作为落后，绿色作为基准 的理由在这两篇文章中解释： blueshift、redshift
额外的状态符号意义：
+: 暂存(staged)*： 未暂存（unstaged）_： 未追踪（untracked）
基础指令：
gita add <repo-path(s)>: 添加库gita context: 情境命令gita context: 显示当前的情境gita context none: 去除情境gita context <group-name>: 把情境设置成group-name, 之后所有的操作只作用到这个组里的库
gita group: 组群命令gita group add <repo-name(s)>: 把库加入新的或者已经存在的组gita group [ll]: 显示已有的组和它们的库gita group ls: 显示已有的组名gita group rename <group-name> <new-name>: 改组名- `gita group rm group(s): 删除组
gita info: 显示已用的和未用的信息项gita ll: 显示所有库的状态信息gita ll <group-name>: 显示一个组群中库的状态信息gita ls: 显示所有库的名字gita ls <repo-name>: 显示一个库的绝对路径gita rename <repo-name> <new-name>: 重命名一个库gita rm <repo-name(s)>: 移除库（不会删除文件）gita -v: 显示版本号
库的路径存在$XDG_CONFIG_HOME/gita/repo_path (多半是~/.config/gita/repo_path)。
代理执行的子命令有两种格式：
gita <sub-command> [repo-name(s) or group-name(s)]: 库名或组群名是可选的，缺失表示所有库gita <sub-command> <repo-name(s) or group-name(s)>: 必须有库名或组群名
默认只有fetch和pull是第一种格式。
如果输入了多个库名， 而且被代理的git指令不需要用户输入， 那么各个库的代理指令会被异步执行。
安装指南
正常人类按装：
pip3 install -U gita
神奇码农安装：先下载源码，然后
pip3 install -e <gita-source-folder>
装完之后在命令行下执行gita可能还不行。那就把下面这个昵称放到.bashrc里。
alias gita="python3 -m gita"
Windows用户可能需要额外的设置来支持彩色的命令行， 见这个帖子。
自动补全
下载
.gita-completion.bash
并在.bashrc里点它。
超人模式
超人模式可以代理执行任何git命令/别名。它的格式是
gita super [repo-name(s) or group-name(s)] <any-git-command-with-or-without-options>
其中库名或组群名是可有可无的。举几个例子
gita super checkout master会把所有库都弄到主库杈上gita super frontend-repo backend-repo commit -am 'implement a new feature'会对frontend-repo和backend-repo运行git commit -am 'implement a new feature'
私人定制
定制的代理子命令要放在$XDG_CONFIG_HOME/gita/cmds.yml (多半是~/.config/gita/cmds.yml)。
如果存在命名冲突，它们会覆盖掉默认的指令。
默认代理子指令的定义可见
cmds.yml。
举个栗子，gita stat <repo-name(s)>的定义是
stat:
cmd: diff --stat
help: show edit statistics
它会执行git diff --stat。
如果被代理的指令是一个单词，cmd也可以省略。比如push。
如果要取消异步执行，把disable_async设成true。比如difftool。
如果你想让定制的命令跟gita fetch等命令一样，可以作用于所有的库，
就把allow_all设成true。
举个栗子，gita comaster [repo-names(s)]会生成一个新的定制命令，对于这个命令，库名是可选输入。comaster的解释如下：
comaster:
cmd: checkout master
allow_all: true
help: checkout the master branch
另一个自定义功能是针对gita ll展示的信息项。
gita info可以展示所有用到的和没用到的信息项，并且可以通过修改$XDG_CONFIG_HOME/gita/info.yml支持自定义。举个栗子，默认的信息项显示配置相当于是：
- branch
- commit_msg
为了创建自己的信息项，命名一个目录为extra_info_items。
在$XDG_CONFIG_HOME/gita/extra_repo_info.py中，要把信息项的名字作为字符串映射到方法中，该方法将库的路径作为输入参数。举个栗子：
def get_delim(path: str) -> str:
return '|'
extra_info_items = {'delim': get_delim}
如果没有遇到问题，你会在gita info的输出内容中的unused小节中看到这些额外信息项。
先决条件
因为用了f-string 和asyncio module，系统必须要用Python 3.6或以上。
暗地里老夫用subprocess来代理执行git指令。所以git的版本有可能会影响结果。
经测试，1.8.3.1, 2.17.2, 和2.20.1的结果是一致的。
有所作为
要想有所作为，你可以
- 报告/治理虫子
- 建议/实现功能
- 加星/推荐本作
聊天请入
在本地跑单元测试可以直接用pytest。更多的细节可见
design.md。
如果你愿意资助我，请访问GitHub Sponsors。
他山之石
没用过，听说不错