Skip to content

Latest commit

 

History

History
112 lines (74 loc) · 5.19 KB

README-ZH.md

File metadata and controls

112 lines (74 loc) · 5.19 KB

🤡 批量删除git分支

npm npm version NPM

在日常开发中我们每做一个需求就会创建一个git功能分支,时间久了本地和线上的分支就会被累计很多。那么此时有一个批量删除git分支的工具就显得尤为重要。GBKILL正是为了解决这一需求也生的工具,让你更加高效的删除git分支

gbkill

该工具将列出项目中的git分支列表,然后您可以批量选择需要删除的git分支

logo.png

Table of Contents

🤡 安装

您实际上不需要安装它即可使用它!只需使用以下命令:

$ npx gbkill

或者你可以安装它:

$ npm i -g gbkill

🏕️ 用法

在你的terminal下输入gbkill(目前不兼容Windows终端的Git)gbkill会执行git命令扫描你当前项目下的git分支并且在列表中展示出来

Key Description
Space 空格键执行已合并分支删除 (推荐: 防止误删除)
Tab Tab键执行已合并 | 未合并分支删除 (权限比Space键高)
RightArrow ->键执行打开 | 关闭批量选择分支功能
移动选择分支
移动选择分支

提示

  1. gbkill界面上的merge列表显示yesNo是通过git branch --merged <name>判断的。你可以通过执行gbkill --merged <name>指定合入的分支名称
  1. gbkillmerge状态为yes时,但你执行该分支删除时出现NO_FORCE...fully merged。原因:该分支代码没有合并到当前聚焦分支。需要强制删除
  1. 当执行gbkill --sync时,会先删除目标分支的远程分支再删除本地分支
  1. 如果你确定你所执行的操作,请使用gbkill --sync --force以及Tab减少限制

🏖️ 参数

gbkill的可配置参数,部分配置参数会被缓存到/用户主目录/.gbkill文件中全局共享

Argument Description Cache
--force 强制删除分支, 等价于git branch -D \<name\> (慎重: 会将本地commit的改动删除掉)
--sync 是否同步删除远程分支
--merged <name> 指定用于判断某个分支是否已经被合并的分支名称 (git branch --merged <name>)
--lock <names..> 锁定某些分支将会在列表隐藏,数据会被累加而不是替换(防止误删,保护某些分支
--unlock <names..> 解锁--lock锁定的分支

🏝️ Git分支状态

分支状态对应的描述

Status Description Color
NONE 分支处于正常状态
DELETING 分支正在删除 🌍
DELETED 分支已删除 🟢
FAILED 分支删除失败 🔴
NO_MERGED 该分支未合并到name分支(--merged <name>) 🟣
NO_FORCE 该分支需要强制删除git branch -D name(--force) 🟡
NO_SYNC 同步删除远程分支失败 🟠

🏞️ 已知问题

⚠️ 目前不支持Windows终端的Git,工具受限于ink,后续查找替代方案。请使用CMDVscode 终端的 Git...终端

⛺ 其它

  1. 该工具会持续优化, 如果你有更好的交互行为或者功能请求都可以给我提pr或者issue
  2. 感谢您使用该工具,也期待你的issue或者pr