SuperAPI AI 工具集

commit-validator

通用与其它

查看项目

更新于 10-16 02:36

技能介绍

用途:按 Conventional Commits 规范校验 git 提交信息,用程序化校验替代原先的文本约定文件。

主要能力:校验格式 <type>(<scope>): <subject>;类型包括 feat、fix、docs、style、refactor、perf、test、chore、ci、build、revert;scope 可选,subject 必填;要求使用祈使现在时、首字母不大写、结尾不加句号;头部长度不超过 72 字符;可包含 body 与 footer(空行分隔)。校验使用正则 /^(feat|fix|docs|style|refactor|perf|test|chore|ci|build|revert)((.+))?: .{1,72}/,并返回结构化结果,如 valid、type、scope、subject、warnings,或 valid、error、suggestions。

使用方式:命令行执行 node .claude/tools/cli/validate-commit.mjs "feat(auth): implement jwt login";也可从标准输入读取,如 echo "fix: incorrect variable name" | node .claude/tools/cli/validate-commit.mjs。可放入 .git/hooks/pre-commit,用 git log -1 --pretty=%B 取信息后调用校验脚本;也可在 CI 中遍历 git log origin/main..HEAD --pretty=%B 逐条校验。

适用场景:需要统一提交规范、生成变更日志与语义化版本的项目。

限制与约定:类型前缀缺失、主题长度超限为阻断项;body/footer 格式问题只警告不阻断;拒绝信息中应给出正确格式示例。资料未提供安装方式、依赖、平台与收费信息。