SuperAPI AI 工具集

code-conventional-commit

通用与其它

查看项目

更新于 10-16 00:06

技能介绍

用途:依据 Conventional Commits 规范生成和校验提交信息,适合在用户要求提交代码或检查提交信息时使用。

主要能力:按 <type>(<scope>): <subject> 格式生成信息,可选正文与页脚;支持 feat、fix、docs、style、refactor、test、chore、perf、ci、build、revert 等类型;可校验类型是否在允许列表内,并检查主题是否为祈使语气、小写、结尾无句号;支持在类型或范围后加 ! 标记破坏性变更,以及 BREAKING CHANGE: 页脚与 Closes #123 之类的议题引用。

使用方式:需要提交时先运行 git status 查看改动文件、运行 git diff --staged 查看暂存内容,据改动判断类型、范围和主题,生成信息后执行 git commit -m "<message>"。校验时解析提交信息并逐项检查格式、类型与主题规则,指出问题。用户说“commit”或“git commit”即由差异生成并提交;说“validate commit”或粘贴提交信息则进行校验。生成提交前先向用户展示信息并请求确认,除非用户明确要求直接执行,确认后再提交并展示结果。

限制与错误处理:无暂存改动时应提示无内容可提交;仓库未初始化时应初始化或提示用户;提交失败时展示错误并可重试。官方文档中未提供其他平台支持、收费方式或性能数据。