SuperAPI AI 工具集

codeprobe-code-smells

编程与开发

查看项目

更新于 10-29 16:14

技能介绍

codeprobe-code-smells 是 codeprobe 体系下的子技能,用于检测代码坏味道与反模式,并按类别组织检测项,输出统一编号(SMELL-001 起)的发现结果。

一、用途与检测范围 该技能覆盖六类问题:

  1. 膨胀类(Bloaters):长方法、大类、数据泥团、基本类型偏执。
  2. 面向对象滥用(Object-Orientation Abusers):依恋情结、不恰当亲密、被拒绝的遗赠。
  3. 变更阻碍(Change Preventers):散弹式修改、发散式变化。
  4. 可弃置(Dispensables):死代码、臆想通用性、中间人。
  5. 耦合(Couplers):时间耦合。
  6. 可读性(Readability):魔法数字、布尔盲点、深层嵌套。 每个检测项均给出信号、检测方式、默认阈值与严重级别。默认阈值包括长方法超过 30 行、大类超过 300 行、深层嵌套超过 3 层等,并可在项目根目录 .codeprobe-config.json 的 severity_overrides 中通过 long_method_loc、large_class_loc、deep_nesting_max 等配置键调整。

二、不检测的情形 该技能明确不标记:生成代码(迁移、编译产物、vendor/、node_modules/、dist/、build/、.next/ 等目录及 GraphQL codegen、Prisma client 等自动生成文件);测试文件中较长的 setUp() 或 beforeEach();条目繁多的配置文件;数据迁移文件;仓库内签入的第三方代码;以及 codeprobe-solid 或 codeprobe-architecture 已标记的结构性问题(虽仍会检测,但由编排器对同一位置的重复发现去重)。大类问题不会升级为 critical,因其属可维护性关注点而非生产缺陷。

三、使用方式 独立模式:不通过编排器直接调用时,需先读取 ../codeprobe/shared-preamble.md(相对于本 SKILL.md 所在位置解析,而非用户项目路径),以获取输出契约、执行模式与约束;再依据项目技术栈从 ../codeprobe/references/ 加载适用的参考文件;默认使用 full 模式,除非用户另行指定。

四、输出与修复提示 发现项以 SMELL- 前缀顺序编号。技能提供修复提示示例,例如将 UserService@register 中第 45-90 行拆分为 validateAndNormalizeInput() 私有方法;将 CacheService.php 第 55 行的魔法数字 86400 替换为具名常量 SECONDS_PER_DAY = 86400;将 OrderProcessor.php 中 processOrder(bool $isExpress, bool $requiresSignature, bool $isFragile) 重构为接收 ShippingOptions 值对象;删除 PaymentGateway.php 第 88-105 行注释掉的死代码;将 ReportGenerator.php 中 95 行的 generate() 方法拆出 fetchReportData() 与 formatReport()。

五、适用场景与限制 适用于对既有代码库进行代码质量审查、重构前诊断,以及经由编排器与其他 codeprobe 子技能协同使用。限制在于:检测依赖阈值配置与模式识别,具体准确度与语言支持范围资料未详述;.codeprobe-config.json 以外的配置方式暂未提供;与其他技能的协作细节仅说明由编排器去重,更多流程暂未提供。