关于 refactor-plan
面向编码 Agent 的技能,用于分析代码库并在修改代码前制定分阶段重构计划。它强调逐阶段验证、高风险阶段的恢复方案,以及实施前等待确认。
主要功能
- 01审查代码库与依赖
- 02安排安全的分阶段修改
- 03设置阶段间验证步骤
- 04为高风险阶段制定回退方案
- 05实施前请求确认
适用场景
- 01规划涉及多个文件的重构
- 02修改前评估潜在耦合
- 03安排契约、实现与测试的变更顺序
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ github/ awesome-copilot --skill refactor-plan安装后在 Claude Code 中输入/refactor-plan确认已加载。
详细介绍
重构计划
在做出任何代码更改之前,先创建一份详细的计划。
说明
- 在准备计划期间,不要编辑文件。
- 搜索代码库以了解当前状态。阅读足够的实现、测试、配置和文档,使计划针对该仓库具体明确。
- 识别受影响的文件、归属边界、依赖关系以及可能隐藏的耦合。
- 按安全的顺序规划更改。优先处理契约和类型,然后是实现,然后是调用方,然后是测试,最后是清理。
- 在各阶段之间包含验证步骤,以及一条最终验证命令。
- 为风险最高的阶段包含回滚或恢复方案。
- 使用下面的格式输出完整的计划。
- 计划完成后停止,并在实施前征求确认。如果用户已经要求你实施,仍然先产出计划并等待确认,除非他们明确表示在计划之后无需审查即可继续。
如果请求过于模糊,无法安全地制定计划,请提出简洁的澄清问题,而不是编辑文件。
输出格式
## Refactor Plan: [title]
### Current State
[Brief description of how things work now]
### Target State
[Brief description of how things will work after]
### Affected Files
| File | Change Type | Dependencies |
|------|-------------|--------------|
| path | modify/create/delete | blocks X, blocked by Y |
### Execution Plan
#### Phase 1: Types and Interfaces
- [ ] Step 1.1: [action] in `file.ts`
- [ ] Verify: [how to check it worked]
#### Phase 2: Implementation
- [ ] Step 2.1: [action] in `file.ts`
- [ ] Verify: [how to check]
#### Phase 3: Tests
- [ ] Step 3.1: Update tests in `file.test.ts`
- [ ] Verify: Run `npm test`
#### Phase 4: Cleanup
- [ ] Remove deprecated code
- [ ] Update documentation
### Rollback Plan
If something fails:
1. [Step to undo]
2. [Step to undo]
### Risks
- [Potential issue and mitigation]
计划完成后,询问:“Shall I proceed with Phase 1?”
评论
支持 Markdown