SuperAPI AI 工具集

design-principles

编程与开发

查看项目

更新于 10-16 01:11

技能介绍

用途:对代码库进行软件设计原则审计,输出带评分的 DESIGN_AUDIT.md 与按优先级排列的整改建议。核心原则是调查而非模式匹配:阅读实际代码判断违规是真实、有意还是误报,仅在有具体 file:line 证据时记录问题。

主要能力:覆盖 SOLID、DRY、YAGNI、KISS、迪米特法则、关注点分离、组合优于继承,以及 12-Factor 中与代码相关的配置、日志、无状态进程子集;支持全量审计、模块审计和由 tech-debt 调用的委派模式。

使用方式:先做前置检查,确保在 git 仓库中,命令为 git --version 2>/dev/null && git rev-parse --is-inside-work-tree 2>/dev/null;非 git 仓库仅警告并继续。随后检测语言、框架与范式及审计范围,逐条读取代码扫描违规,按 Impact、Effort、Priority 打分并对争议项进行红蓝白对抗辩论,最后生成报告并运行 markdownlint DESIGN_AUDIT.md,必要时用 npx markdownlint-cli。

适用场景:需要系统性评估设计质量、识别重复与过度设计、规划重构优先级的项目。

限制:非 git 仓库时无法使用历史信息;不靠关键字搜索判断,需人工或模型阅读真实调用路径;评分、工作量与优先级属主观判断。未提供收费、平台等更多信息。