mcpField
C
codebase-cleanup-refactor-clean

codebase-cleanup-refactor-clean

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

关于 codebase-cleanup-refactor-clean

面向代码重构的技能,帮助开发者提升可维护性并保持现有行为。它强调分步实施、评估风险和验证改动。

主要功能

  1. 01识别重构目标与风险
  2. 02拆分为可测试步骤
  3. 03保持行为与兼容性
  4. 04通过测试和回归检查验证
  5. 05确保改动便于审查和回退

适用场景

  1. 01清理大型代码库中的重复代码
  2. 02为新增功能整理代码
  3. 03提升模块可读性与可维护性

安装

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

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

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

附带文件resources/implementation-playbook.md

详细介绍

重构与整洁代码

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

适用场景

  • 清理积累了技术债的大型代码库
  • 消除重复代码并简化模块
  • 为代码库开发新功能做准备
  • 使实现符合整洁代码标准

不适用场景

  • 只需进行微小的针对性修复
  • 政策或截止期限阻碍了重构
  • 请求仅涉及文档

背景

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

要求

$ARGUMENTS

指示

  • 找出影响较大的重构候选项和风险。
  • 将工作拆分为小型、可测试的步骤。
  • 实施更改时注重可读性和稳定性。
  • 使用测试和有针对性的回归检查进行验证。
  • 如需了解详细模式,请打开 resources/implementation-playbook.md。

安全

  • 未就范围达成一致前,避免大规模重写。
  • 确保更改易于审查和回退。

输出格式

  • 按优先级排序的清理计划
  • 关键重构目标及其理由
  • 预期影响和风险说明
  • 测试/验证计划

资源

  • resources/implementation-playbook.md,包含详细模式和示例。

限制

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

保持行为不变与证据

数值型代码异味、覆盖率和投资回报率阈值仅为启发式指标,并非通用质量门槛或经过测量的收益。除非明确要求更改,否则应保持公开行为、重复项顺序、事务、副作用时机、错误和兼容性不变。对于风险较高的重构,应先明确有意义的不变量;不要为了满足行数或参数数量限制而机械地拆分函数。

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

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

评论

支持 Markdown