SuperAPI AI 工具集

validate-git

编程与开发

查看项目

更新于 10-16 07:30

技能介绍

用途

validate-git 是一个 Git 规则合规校验技能,对应规则文档 docs/specs/git.md。它用于在只读前提下检查当前 Git 仓库是否符合既定的分支命名、提交信息与敏感文件防护规范,帮助团队在提交或评审前发现不合规项。

主要能力

该技能执行以下四类检查:

  1. 当前分支检查:通过 git branch --show-current 获取当前分支,若处于受保护分支(main、master、develop)则给出警告。
  2. 分支命名校验:允许的前缀为 feature/、fix/、hotfix/、refactor/、chore/、docs/;无前缀的分支会收到警告(受保护分支除外)。
  3. 提交信息校验:通过 git log -5 --format="%s" 检查最近 5 条提交信息,要求匹配 Conventional Commits 的 {type}({scope}): {subject} 格式。允许的类型为 feat、fix、refactor、docs、style、test、chore、perf;不带 scope 的 {type}: {subject} 形式会被接受但给出警告。
  4. 敏感文件检测:通过 git log --all --diff-filter=A --name-only 检查历史中是否新增过敏感文件,检测模式包括 .env、.env.、credentials、.pem、.key、secrets*。一旦检测到,判定为 FAIL。

使用方式

该技能自动检测当前 Git 仓库,无需额外输入。执行逻辑依次完成上述四步检查,并强制输出 Git 验证矩阵,矩阵包含项目、状态、结果、详情与证据五列,覆盖当前分支、分支命名、最近 5 条提交以及敏感文件。状态取值包括 PASS、WARN、FAIL,以及 NOT_APPLICABLE(非 Git 仓库)、SKIPPED(未使用 Git)、SHALLOW(部分检查)。

在生成最终报告前,技能要求完成预输出检查清单:每个项目都必须有状态值;状态不为 SKIPPED 的项目必须有证据值;执行逻辑的四步全部完成;每个 WARN/FAIL 项包含具体详情;报告语言与用户对话语言一致。

最终输出为 Git 规则合规报告,包含各检查项的状态与详情,并汇总通过、警告与失败数量。

输出持久化

生成报告后,结果会持久化到 .ww-w-ai/standards/validate-git/ 目录:

  • 若目录不存在则创建;
  • 写入 latest.json(遵循 templates/schema.json 的结构化结果);
  • 写入 latest.md(遵循 templates/report.template.md 的可读报告);
  • 将 latest.json 复制到 history/{timestamp}.json 进行归档。

latest.md 使用用户对话语言生成,JSON 字段名保持英文。JSON 输出便于机器解析的历史追踪与跨运行比较,history/ 目录保留历史运行记录以支持趋势分析。写入权限仅限于 .ww-w-ai/standards/ 输出持久化,不修改项目源码。

适用场景

适用于需要在提交前或代码评审阶段自动检查 Git 规范合规性的场景,例如确保分支命名统一、提交信息符合 Conventional Commits、避免敏感文件被提交进仓库。

限制

该技能为只读操作,仅查询 Git 历史,不执行分支创建/删除、commit、push 等修改命令。对受保护分支的警告不会强制切换分支,决定权留给用户。敏感文件检测基于文件名模式,不进行基于内容的敏感信息检测。