DSH VERTICAL KIT · 提交信息检查 / commit message 检查
提交信息检查清单
它决定一件事:这条提交信息是否可被工具解析、在 log 里可读。
检查规则
| 规则 | 判定 |
|---|---|
type-missing | 没有 type(scope): subject 前缀 → error |
type-unknown | 类型不在已知集合(feat/fix/docs/…)→ warn |
subject-long | 主题超过上限(默认 72)→ error |
subject-empty | 冒号后没有主题 → error |
subject-period | 主题以句号结尾 → warn |
body-separator | 标题后没有空行 → error |
breaking-untrailed | 用了 ! 但正文没有 BREAKING CHANGE: trailer → warn |
用法
npx commit-msg-check .git/COMMIT_EDITMSG --jsonnpx commit-msg-check msg.txt --max-subject 50
真实输入输出
输入
修了几个 bug$ commit-msg-check commit-sample.txt
error type-missing 第1行 第 1 行没有类型前缀(认得:feat/fix/docs/style/refactor/perf/test/build/ci/chore/revert)——「修了几个 bug」看不出这次改动的性质
fail: type=- subject=8ch, 1 errors, 0 warnings
出口码:1。输出为真实 CLI 运行的逐字结果,由测试与工具保持同步。
出口码:0 干净、1 有发现、2 用法或读文件错误。--json 输出机器可读结果。DSH 内同样的函数在 POST /commit-msg-check/api({"text":"…"} 或 {"path":"…"}),面板与 CI 调同一实现。
这是清单,不是专业人士。合同检查不是法律意见,发票检查不判税务合规,listing 检查不判商业价值。每条发现都是文本里可判定的结构缺陷,带行号。
只验信息形状,不验提交内容:它验证信息能被工具解析、在 log 里可读;diff 是否做了主题说的事,靠评审。信息全过规则但描述错了改动,这个工具无话可说,也不假装有。 · dsh-vertical-kit · 通用检查(哈希/引用/结构/表格/数字)在 dsh-verify-kit