Documentation
¶
Overview ¶
baseline.go —— 基线比较、棘轮与读写(issue #400)。
Command seamcheck 统计「宿主接缝契约成文率」并做棘轮校验(issue #400, 补 #369 的统计面 / 给 #370 提供可机判基线)。
什么算一条接缝 ¶
**宿主接缝** = 宿主必须实现或注入的导出类型声明,本工具认两类:
- 导出 interface(至少一个方法):宿主实现它;
- 导出命名函数类型(排除 *Option 配置函子):宿主注入回调。
包级 main 不计(命令工具不是宿主接缝)。这是一条**可复现的**口径:同一份 源码扫两次必得同一集合;新增/删除接缝会改变清单,必须显式 -update 入基线 (「清单缺一即红」)。
三个数 ¶
- declarations:接缝声明数;
- callsites:**类型感知**的接缝调用点数(静态接收者类型是接缝 interface 的方法调用 + 静态类型是接缝函数类型的调用)——不是按方法名猜的近似值;
- fully_written:三条约束(不得重入 / 不得阻塞 / panic 隔离)在接缝文档 (interface 含方法注释)里**都写齐**的接缝数。
棘轮 ¶
基线(缺省 seam-baseline.json)同时记录集合与每个接缝已写的约束:
- 当前接缝集合必须与基线**逐条相等**(少一条 / 多一条都红);
- 每个接缝已写的约束只允许**增加**(基线写了 panic 隔离,当前就不能没有);
- fully_written 总数只允许上升。
-update 生成基线时同样拒绝回退(除非 -force):棘轮不是「跑一次 -update 就重置」的装饰。
scan.go —— 接缝枚举、调用点计数与约束成文判定(issue #400)。
Click to show internal directories.
Click to hide internal directories.