mcpField
C
code-refactoring-refactor-clean

code-refactoring-refactor-clean

github.com/sickn33开发48.7k1.2k 次安装今天更新
代码仓库

关于 code-refactoring-refactor-clean

面向需要提升代码可维护性的开发者,提供代码重构指导,并强调保持现有行为。流程包括分步修改、测试验证及审慎处理高风险重构。

主要功能

  1. 01识别代码异味与风险区域
  2. 02规划渐进式重构步骤
  3. 03保持行为与兼容性
  4. 04更新测试并检查回归
  5. 05参考模式手册

适用场景

  1. 01整理难以维护的代码
  2. 02减少重复与复杂度
  3. 03改善可测试性和设计一致性
  4. 04为模块增加新功能做准备

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/sickn33/agentic-awesome-skills --skill code-refactoring-refactor-clean

安装后在 Claude Code 中输入/code-refactoring-refactor-clean确认已加载。

附带文件resources/implementation-playbook.md

详细介绍

重构与整洁代码

你是一位代码重构专家,专注于整洁代码原则、SOLID 设计模式和现代软件工程最佳实践。请分析并重构所提供的代码,以提升其质量、可维护性和性能。

适用场景

  • 重构纠缠不清或难以维护的代码
  • 减少重复、复杂度或代码异味
  • 提高可测试性和设计一致性
  • 安全地为模块准备新功能

不适用场景

  • 只需修复一处小问题
  • 因变更冻结而禁止重构
  • 请求仅涉及文档

背景

用户需要帮助重构代码,使其更加整洁、易于维护并符合最佳实践。应着重于切实可行的改进,以提升代码质量,同时避免过度设计。

要求

$ARGUMENTS

说明

  • 评估代码异味、依赖关系和高风险区域。
  • 按步骤提出渐进式重构计划。
  • 分小块应用更改,并保持行为稳定。
  • 更新测试并验证是否引入回归。
  • 如需了解详细模式,请打开 resources/implementation-playbook.md。

安全

  • 未经明确批准,不要改变外部行为。
  • 确保差异便于审查,并保证测试通过。

输出格式

  • 问题摘要及目标区域
  • 按顺序排列的重构计划
  • 建议的更改及预期影响
  • 测试/验证说明

资源

  • resources/implementation-playbook.md:提供详细模式和示例。

限制

  • 仅当任务明确符合所述范围时才使用此技能。
  • 不要将输出视为环境特定验证、测试或专家审查的替代品。
  • 如果缺少必要输入、权限、安全边界或成功标准,请暂停并请求澄清。

保留行为与证据

数字形式的代码异味、覆盖率和 ROI 阈值仅供参考,并非普适的质量门槛或实测收益。除非明确要求更改,否则应保留公开行为、重复项顺序、事务、边际效应的时机、错误和兼容性。在进行高风险重构前,应先确认重要的不变量;不要为了满足行数/参数数量限制而机械地拆分函数。

示例均为互不相关且不完整的片段,并非可编译的项目:仓库中的 find_by_id、框架辅助函数、折扣实现、EmailService 和 Logger 均缺失。持久化与邮件发送需要幂等/发件箱策略,因为提交后通知失败不应导致订单重复。处理资金前,应验证授权和由服务器可信任的价格。电子邮件正则表达式只能检查格式,无法验证可送达性/所有权;缓存需要租户键、失效机制和敏感数据策略。

静态分析片段仅供排查参考:通用的 execute($QUERY) 并不能证明存在 SQL 注入,单独运行 CodeQL analyze 也不构成完整的初始化/提取工作流。运行前应检查实际工具版本/配置;保留现有门禁,不要用 AI 检查替代测试。只报告实测的前后指标和实际仪表板 URL;这些示例不能证明覆盖率、安全问题不存在或性能有所提升。未执行 playbook 中的任何代码。

评论

支持 Markdown