关于 refactor-legacy-code
面向维护旧代码库的开发者的重构技能,强调以经过测试的小步改动提升可读性和可维护性,同时保留现有行为。
主要功能
- 01评估代码与复杂度
- 02建立测试安全网
- 03分步小幅重构
- 04更新代码模式与 API
- 05减少依赖项
适用场景
- 01更新已弃用的代码模式
- 02减少现有代码库的技术债
- 03从单体代码中提取可复用部分
- 04为开发新功能做好代码准备
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ aj-geddes/ useful-ai-prompts --skill refactor-legacy-code安装后在 Claude Code 中输入/refactor-legacy-code确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
references/benefits-achieved.mdcode-assessment.mdcomplete-refactoring-example.mdestablish-safety-net.mdincremental-refactoring.mdmodernize-patterns.mdreduce-dependencies.mdscripts/scaffold-tests.shtemplates/test-template.js详细介绍
重构遗留代码
目录
概述
此技能可帮助你系统地重构遗留代码,在保留现有功能的同时提高可维护性、可读性和性能。它遵循行业最佳实践,通过全面测试确保重构安全。
适用场景
- 将过时的代码模式或已弃用的 API 现代化
- 减少现有代码库中的技术债务
- 提高代码的可读性和可维护性
- 从单体代码中提取可复用组件
- 升级到较新的语言特性或框架
- 为开发新功能做好代码准备
快速入门
首先,分析遗留代码以了解:
# Review the codebase structure
tree -L 3 -I 'node_modules|dist|build'
# Check for outdated dependencies
npm outdated # or pip list --outdated, composer outdated, etc.
# Identify code complexity hotspots
# Use tools like:
# - SonarQube for code smells
# - eslint for JavaScript
# - pylint for Python
# - RuboCop for Ruby
参考指南
references/ 目录中的详细实现:
| 指南 | 内容 |
|---|---|
| 代码评估 | 代码评估 |
| 建立安全网 | 建立安全网 |
| 渐进式重构 | 渐进式重构 |
| 模式现代化 | 模式现代化 |
| 减少依赖 | 减少依赖、文档 |
| 完整重构示例 | 完整重构示例 |
| 已实现的收益 | 已实现的收益 |
最佳实践
✅ 应该做
- 渐进式重构:进行小规模、可测试的更改
- 频繁运行测试:每完成一个重构步骤后都运行测试
- 经常提交:创建有逻辑、原子化的提交
- 确保现有测试通过:不要破坏功能
- 使用 IDE 重构工具:比手动编辑更安全
- 检查代码覆盖率:确保测试覆盖重构后的代码
- 记录决策:说明原因,而不只是内容
- 寻求同行评审:新的视角有助于发现问题
❌ 不应该做
- 将重构与新功能混在一起:分开处理
- 不写测试就重构:这很容易导致破坏性更改
- 更改行为:重构应保留原有功能
- 一次重构大段代码:会增加风险和评审难度
- 忽视代码异味:系统地处理它们
- 跳过文档:未来的维护者需要了解背景
评论
支持 Markdown