SuperAPI AI 工具集

reviewing-code-modularity

编程与开发

查看项目

更新于 10-26 16:22

技能介绍

用途

该技能用于在审查或修改代码结构时,帮助降低复杂度、提升模块化程度,使代码库更易于理解、变更、测试和删除。适用于用户没有明确提出“结构”诉求、但实际在讨论代码组织方式的场景。它不是自动化重构工具,而是一套结构审查与最小化重构的方法规范。

主要能力

  • 结构审查:按风险排序输出发现,标注严重级别(high/medium/low)、文件与行号、复杂度成因及最小修复建议。
  • 复杂度识别:关注变更放大、认知负荷、未知未知(隐藏行为与意外依赖)、晦涩命名四类问题。
  • 模块设计指导:偏好深模块与信息隐藏,警惕只做转发的浅层模块。
  • 依赖方向检查:后端 routes→services→repositories、前端 pages→feature components→shared UI、库 public API→internal→low-level helpers,并映射到项目既有词汇,而非生搬硬套。
  • 抽象纪律:仅在存在现实压力(多调用方、细节泄漏、测试接缝、变更扩散、公共 API 简化)时才引入抽象。
  • 文件拆分原则:按职责而非行数拆分。
  • 命名与错误处理规范:避免 manager、helper、utils 等含糊命名;集中错误转换,统一 API 错误形态。
  • 重构约束:保持行为不变、不静默修改公共 API、不引入无依据的新依赖、不夹带无关重构。

使用方式

技能按工作流执行:先理解请求的行为或问题,检查现有项目结构与邻近代码,识别受影响的模块及其职责、隐藏内容、公共 API、导入关系与可测试性;再查找复杂度警示信号,提出最小的有用重构;审查/设计类任务只给建议,实现类任务做最小的保持行为变更;若有改动则运行最小相关测试、类型检查、lint、导入边界检查并审查最终 diff;最后总结权衡与剩余风险。技能附带 references 目录(red-flags.md、principles.md、examples.md),按需用 rg 或 grep 检索相关章节,避免整篇通读。

适用场景

代码评审、结构调整设计讨论、功能开发中顺带的小型结构改进、模块边界与依赖方向梳理、命名与错误处理一致性检查。

限制

该技能明确反对为架构而架构,不强制推行 Clean Architecture、六边形架构、DDD 或企业级分层;不提供具体语言或框架的自动化重构命令;若无法运行验证(测试、类型检查、lint),需明确说明。其参考资料的具体内容与完整细节需查阅源仓库文件。