SuperAPI AI 工具集

clean-code-ts

编程与开发

查看项目

更新于 10-16 06:13

技能介绍

用途:对用户提供的 TypeScript 或 TSX 代码按 Clean Code(Robert C. Martin 著,适配 TypeScript)原则进行审查并给出重构版本。开始前需阅读技能目录中的 references/rules.md,其中按类别(变量、函数、对象与数据结构、类、SOLID、测试、并发、错误处理、格式、注释)列出完整规则集。

主要能力:逐行分析代码,识别违反规则之处,记录违反的规则名、出现位置(函数、类或行范围)及影响原因;按固定格式输出报告,包含总结、按类别分组的问题表格(含规则、位置、问题、严重程度 🔴 高 / 🟡 中 / 🟢 低)、重构后的完整代码与关键改动列表。

使用方式:用户以内联、文件或路径方式提供 TypeScript/TSX 代码即可。重构优先级依次为:保持行为不变,最大化清晰度,避免引入原作者未使用的模式,保持方案复杂度与问题匹配。可只要求审查(跳过重构,问题表增加建议修复列)或只要求重构(跳过问题表,仅返回代码与关键改动)。

适用场景:适用于希望提升 TypeScript 代码可读性与可维护性的开发者,包括与 React、Angular、NestJS 等框架模式混用的代码。

限制:这是可读性重构,不改变功能。代码本身已足够整洁时应直接说明,不制造问题。代码超过约 300 行时聚焦最有影响的问题(上限约 15 至 20 项)。框架惯用模式可能看似违规实则不是,如 Angular 装饰器、React hooks 命名。产品定价、平台支持等信息暂未提供。