SuperAPI AI 工具集

speckit-git-validate

编程与开发

查看项目

更新于 10-24 10:10

技能介绍

speckit-git-validate 属于规范驱动的开发流程辅助工具,核心用途是验证当前 Git 分支名称是否符合约定的特性分支命名规范,从而在开发早期发现分支命名与规格目录不一致的问题。

主要能力包括:检测当前环境是否处于 Git 仓库中,读取当前分支名,并按两种规则进行匹配——序号式命名(^[0-9]{3,}-,如 001-feature-name、042-fix-bug、1000-big-feature)与时间戳式命名(^[0-9]{8}-[0-9]{6}-,如 20260319-143022-feature-name)。在匹配成功后,工具会进一步检查 specs/ 目录下是否存在以该分支数字前缀开头的规格目录,并分别输出找到或缺失的提示。若当前分支不符合命名规则,会明确提示分支不符合特性分支规范,并给出两种合法命名示例。

使用方式上,工具以命令形式执行,内部调用 git rev-parse --is-inside-work-tree 2>/dev/null 判断 Git 可用性,通过 git rev-parse --abbrev-ref HEAD 获取当前分支名。当 Git 不可用或当前目录不是 Git 仓库时,工具会输出警告并跳过校验;同时会尝试读取 SPECIFY_FEATURE 环境变量作为降级方案,对该变量值执行相同的命名模式校验,若未设置则输出警告并跳过。

适用场景主要是采用规范驱动开发、要求分支名与 specs/ 规格目录一一对应的项目,例如在创建或切换特性分支后执行自检,或在持续集成流程中作为分支命名检查的一环。

限制方面:仅覆盖两种固定的命名模式,不支持自定义规则;规格目录检查仅依据数字前缀在 specs/ 下做匹配;在非 Git 环境中只能依赖 SPECIFY_FEATURE 环境变量,否则跳过校验。