SuperAPI AI 工具集

dry-code-review

测试与质量

查看项目

更新于 10-16 05:07

技能介绍

用途:对代码库执行结构化、彻底的 DRY 原则代码审查,系统性地找出违反 DRY 的地方并给出修复建议。审查过程通过 plans/ 目录下的 markdown 文件进行规划与跟踪。

主要能力:分五个阶段推进。阶段一为准备与发现,创建 plans/dry-review-<project-name>.md 跟踪计划,盘点源码文件的语言、大小与角色,并与用户确认纳入或排除的目录(如跳过 node_modules、vendor、生成文件、测试夹具)。阶段二为自动扫描,运行脚本 bash /path/to/dry-code-review/scripts/find_duplicates.sh <target_directory> [extensions],检测重复 3 行以上的相同或近似代码块、重复字符串字面量与魔法数字、跨文件相似函数签名、重复样板与配置模式;导入/依赖行被有意排除以免干扰结果。阶段三为人工分析,阅读代码查找四类违规:字面重复、结构重复、逻辑重复、横切重复。阶段四记录发现,每条含 ID、类别、严重度(高/中/低)、位置(文件路径与行号)、描述、重构建议与工作量估计。阶段五汇总并按类别与严重度统计,给出优先行动清单、整体修复工作量估计与风险说明。

常见重构建议包括:提取函数/方法、提取常量或配置、创建基类或混入、使用高阶函数、建立共享工具模块、使用模板或泛型、应用策略模式、合并配置。

使用方式:按阶段执行,随进度更新计划文件中的复选框;发现需具体到文件路径与行号。

限制与注意:不要过度 DRY,并非所有重复都有害(如测试可读性、有意反规范化、简单两行模式),应标注但说明可接受的情况;尊重边界,看似相似但服务不同领域的代码可能应保持独立;考虑变更频率,频繁修改的代码比稳定代码更受益;重构不应降低可读性。资料未提供该技能的安装方式、收费、支持平台或效果数据。