SuperAPI AI 工具集

fable-implementation

编程与开发

查看项目

更新于 10-16 08:02

技能介绍

fable-implementation 是五个 fable-* 技能中的第四个,聚焦“手落在代码上”这一刻。核心标准只有一条,逐行检验:审阅者能否分辨出原有代码在哪里结束、你的改动从哪里开始?若不能,就写出了“原生 diff”——读起来像代码库自己的作者写的改动。

用途:把新代码写得像本来就属于这个代码库,减少审阅者需要停下来盘问的接缝。原生 diff 不是风格偏好,而是对正确性的礼貌:每个可被察觉的接缝都会让未来的读者付出代价。它与 clean-code(修复已有代码)和 coding-implementation-guard(验证改动安全)分工不同,本技能只管新行如何读。

主要能力与要求:

  1. 匹配实际存在的写法。动笔前先读邻近代码——上方函数、同级模块、最近的测试——匹配三件事:命名与惯用法(若文件用 early return 就用 early return,错误以异常冒泡就不要引入 result tuples);注释密度(匹配周边比例,但确实承载约束的注释不受密度限制);信任级别(匹配周边代码的自我防御程度,避免无来由的 null 检查、try/except 包装和回退分支这类“防御表演”)。

  2. 信任边界例外。跨越信任边界的数据——用户输入、外部 API 响应、反序列化内容——无论邻近代码多宽松都应校验。断言不算表演:表演会软化失败(回退、吞异常、静默默认值),断言让被破坏的假设在源头崩溃。

  3. 只写有必要的注释。注释有资格,是因为它承载代码无法表达的约束:不变量、外部系统的怪癖、不明显的 why。叙述(// increment the counter)和给审阅者的备注(// moved from utils.py)是噪音,PR 合并即过期。

  4. 改动范围由任务界定。只碰任务需要的东西;顺带发现的不当命名、死导入、该拆分的函数,记录下来留待单独改动,不在本次 diff 里做。例外是诚实必需:任务确实无法在不做更大改动时落地时,那更大改动就是任务本身,说出来而不是偷偷夹带。

使用方式:写作前读周边、写作中按上述三条匹配、完成前把整个改动当作审阅者重读一遍,找出接缝并明确给出判断。

限制:资料未提供安装命令、代码示例、支持平台、定价或其他运行信息。相关技能包括 fable-intake(读请求)、fable-diagnosis(查失败)、fable-decision(选方案)、fable-reporting(沟通结果)。