用途:create-branch 用于创建并检出新的 git 分支,带有智能校验与 GitHub Issue 集成,帮助团队保持分支命名规范。
主要能力:
- Issue 集成优先:用户提供 issue 编号(如 #123、123、issue 123)时,优先使用 GitHub CLI。先运行 gh --version 检查可用性,再运行 gh issue view <issue-number> 确认 issue 存在并显示标题与状态,然后运行 gh issue develop <issue-number> -c 创建并检出分支(-c 自动切换),分支名由 GitHub 依 issue 标题生成并关联该 issue,随后跳到远程推送步骤。
- 手动创建流程:无 issue 编号时,依次检查仓库状态(git status)、向用户获取分支名、自动推断前缀、校验命名、检查本地与远程重名、确定基础分支、创建并检出、询问是否推送远程。
- 前缀自动推断:feature/(add、implement、create、new、feature)、bugfix/(fix、bug、resolve、patch、repair)、hotfix/(hotfix、urgent、critical、emergency)、chore/(chore、refactor、update、upgrade、maintain)、docs/(docs、documentation、readme、guide)。若输入已带已识别前缀则保留。
- 命名校验:转为小写、空格与下划线替换为连字符,格式为 prefix/kebab-case-name;拒绝包含 ~、^、:、?、*、[、]、\、@{、.. 等特殊字符及控制字符、非 ASCII 字符;禁止首尾斜杠或连字符;去掉前缀后最少 3 个字符,总长最多 100 字符。
- 重名检查:本地用 git branch --list "<branch-name>",远程用 git ls-remote --heads origin "<branch-name>"。本地存在可切换,远程存在则警告并建议改名。
- 基础分支判定:先 git rev-parse --verify main,不存在再试 master,两者都无则用当前 HEAD,也可由用户指定。
- 创建与推送:git checkout -b <validated-branch-name> <base-branch>;确认后询问是否推送并设置跟踪,若是则 git push -u origin <branch-name>。
- 语言约定:从现有分支名、提交信息和文档推断项目语言变体(如美式或英式英语),在分支名与输出中保持一致拼写。
错误处理:非 git 仓库提示初始化或切换目录;缺少 gh 时提示从 https://cli.github.com 安装或改用手动创建;issue 未找到提示检查编号;分支名非法给出建议;分支已存在给出切换或改名提示;网络问题则仅本地创建。
适用场景:需要规范化分支命名的团队、将分支与 GitHub issue 关联以追踪项目、希望减少分支命名错误的开发者。
限制:依赖 git;Issue 集成依赖 GitHub CLI 与 GitHub 平台;收费、价格、平台版本等未提供。