SuperAPI AI 工具集

clean-code-size

编程与开发

查看项目

更新于 10-16 02:39

技能介绍

clean-code-size 是一个文件与模块体量的分诊技能,角色定位为“文件和模块体积分诊专家”,分为两个阶段:先用确定性扫描找出客观过大的源文件,再对确实有问题的文件以软件架构评审的思路提出更小的组件拆分方案。它本身不实施拆分,代码改动交由 clean-code-refactor(文件内清理)或 [language]-data-engineer(经批准的结构性改动)处理。

输入参数:target_path(必填,要扫描的文件或目录);language(选填,auto 为默认,可选 python、javascript、csharp、rust);max_lines(选填,覆盖默认语言阈值);top_n(选填,报告中包含的超大文件数量,默认 10)。

工作流程:第 1 步运行捆绑脚本进行确定性扫描,命令为 python3 skills/clean-code-size/scripts/report_large_files.py <target_path> --language <language-or-auto> --top <top_n>,如提供 max_lines 则加 --max-lines <value>;脚本报告总行数、非空行数、语言、所用阈值和超出量。第 2 步阅读 references/size-thresholds.md 以及 clean-code-reviewer 下对应语言的说明文件(python.md、javascript.md、csharp.md、rust.md),把阈值视为分诊信号而非绝对法则,职责比行数更重要。第 3 步过滤误报:生成代码、注册表或常量文件、快照夹具、测试数据构建器、协议或模式声明等虽然大但结构连贯的文件应记为豁免。第 4 步只完整阅读被标记的文件,识别混在一起的主要职责、可拆分的自然接缝,以及问题是一个函数或类还是模块边界本身;若问题局限于单个函数或类,则转交 clean-code-refactor。第 5 步对确需结构拆分的文件,打开 skills/software-architect/SKILL.md 并在本地应用其评审模式,产出文件内的隐式架构、目标组件分解、各组件职责、依赖方向和可安全实施的迁移顺序;在本技能内使用时保持工作本地化,除用户明确要求外不发布到 Confluence,且聚焦现有代码的分解而非全新系统设计。第 6 步输出组合报告,含扫描结果与架构提案,使用指定标题与表格结构。

决策规则:未超过阈值则仅报告扫描结果,说明没有基于体积的拆分候选;判断严重程度优先使用非空行数;除非用户明确要求全面分析,深层架构提案限制在排名前 3 至 5 个文件;未解释依赖影响时不要提议包或命名空间变更;本技能不实施拆分,方案被接受后交给相应的下游技能实施。