SuperAPI AI 工具集

gs-codebase-design

编程与开发

查看项目

更新于 11-15 16:33

技能介绍

用途 该 Skill 面向正在设计或重构代码的场景,提供一套共享词汇与原则,目标是让调用方获得杠杆(leverage)、让维护者获得局部性(locality),并让所有人获得可测试性。它强调模块应做到“小接口、大量行为”。

主要能力

  1. 统一术语:要求严格使用 Module(模块)、Interface(接口)、Implementation(实现)、Depth(深度)、Seam(接缝)、Adapter(适配器)、Leverage(杠杆)、Locality(局部性),避免用 component、service、API、boundary 等替代词。
  2. 接口定义:接口不仅包括类型签名,还包括调用方正确使用模块所需知道的一切,如不变量、顺序约束、错误模式、必要配置和性能特征。
  3. 深与浅的区分:深模块是小接口加大量隐藏实现;浅模块是接口几乎和实现一样复杂,应避免。设计接口时可自问:能否减少方法数量、简化参数、把更多复杂性藏到内部。
  4. 设计原则:深度是接口的属性而非实现的属性;删除测试(想象删除该模块,复杂度消失说明是直通,复杂度在多个调用方重现说明它在发挥作用);接口即测试面;一个适配器只意味着假想接缝,两个适配器才是真实接缝,不要在没有任何变化跨越接缝时引入接缝。
  5. 可测试性设计:接受依赖而非自行创建依赖(如 processOrder(order, paymentGateway) 优于内部 new StripeGateway());返回结果而非产生副作用(如 calculateDiscount(cart): Discount 优于 applyDiscount(cart): void);保持小表面积。
  6. 关系定义:模块恰有一个接口;深度是相对于接口衡量的模块属性;接缝是模块接口所在之处;适配器位于接缝处并满足接口;深度为调用方产生杠杆、为维护者产生局部性。
  7. 明确拒绝的框架:不以实现行数与接口行数之比定义深度;不把“接口”窄化为 TypeScript interface 关键字或类的公开方法;不使用“boundary”一词。
  8. 深入资料:DEEPENING.md 说明在给定依赖下加深一组模块,包括依赖分类、接缝纪律与“替换而非分层”的测试方式;DESIGN-IT-TWICE.md 说明如何用并行子代理以多种截然不同的方式设计接口,再从深度、局部性和接缝位置进行比较。

使用方式 资料未提供具体安装命令或调用步骤,暂未提供。从描述看,它是在用户想要设计或改进模块接口、寻找加深机会、决定接缝位置时使用的共享词汇 Skill。

适用场景 设计或重构代码时统一团队对模块、接口与接缝的语言;评估现有模块是深是浅;改进接口以减少方法数量与参数复杂度;为可测试性调整依赖注入与返回值设计;判断是否应引入接缝与适配器。

限制 资料为设计方法论,未提供具体平台的集成方式、收费信息或效果数据,暂未提供。