Codex 使用场景
重构您的代码库
在保持现有行为不变的前提下,清除死代码,更新过时的写法。
使用 Codex 清除死代码、理顺大型文件的结构、合并重复逻辑并更新过时的写法。每次只做一小部分改动,便于逐步审查。
最适合
- 因死代码、过大的模块、重复逻辑或过时的抽象而难以进行日常修改的代码库。
- 需要在现有代码基础上进行改进,同时避免迁移框架或技术栈的团队。
目录
重构您的代码库
在保持现有行为不变的前提下,清除死代码,更新过时的写法。
使用 Codex 清除死代码、理顺大型文件的结构、合并重复逻辑并更新过时的写法。每次只做一小部分改动,便于逐步审查。
最适合
- 因死代码、过大的模块、重复逻辑或过时的抽象而难以进行日常修改的代码库。
- 需要在现有代码基础上进行改进,同时避免迁移框架或技术栈的团队。
技能与插件
- 在合并每一轮改动前,审查涉及安全的代码清理、依赖项变更、身份验证流程以及对外暴露的接口和功能。
- 将经过验证的代码改进方法、审查清单或行为一致性验证流程整理成技能,供代码仓库或团队复用。
| 技能 | 使用理由 |
|---|---|
| Security Best Practices | 在合并每一轮改动前,审查涉及安全的代码清理、依赖项变更、身份验证流程以及对外暴露的接口和功能。 |
| Skill Creator | 将经过验证的代码改进方法、审查清单或行为一致性验证流程整理成技能,供代码仓库或团队复用。 |
起始提示词
简介
如果您的代码库中积累了未使用的代码、重复的逻辑、过时的抽象、过大的文件或陈旧的实现模式,导致每次修改都要多花工夫,就该考虑通过重构减少技术债务。重构的目的是改善现有系统的结构,无需迁移技术栈。
Codex 可以先梳理难以维护的代码,理清各部分之间的关系,再分轮清理,让每轮改动都便于审查。它可以删除不再使用的代码路径,理顺大型模块的内部结构,合并重复的代码路径,更新框架的旧式用法,并加强对每轮改动的验证。
目标是在现有代码库的基础上完成以下改进:
- 删除未使用的代码、过时的辅助函数、旧标志以及不再需要的兼容层。
- 通过提取辅助函数、拆分组件,或将副作用移到职责更明确的位置,精简杂乱的模块。
- 按照代码仓库现行的约定更新旧式写法,例如采用较新的框架原语、更清晰的类型、更简单的状态流转方式或标准库提供的工具。
- 保持系统的对外行为稳定,同时降低后续修改的成本。
使用方法
- 编辑前,请先让 Codex 梳理待重构的范围,找出杂乱的模块、重复的逻辑、未使用的代码,以及已不适合当前代码仓库的旧式写法,同时列出相关测试和对外契约。
- 每次只处理一类问题,例如删除未使用的代码、简化控制流、更新过时的写法,或将大文件拆成几个各有明确维护者的小文件。
- 在 Codex 修改文件前,请让它说明代码目前的行为、打算如何改进结构,以及最少需要做什么检查才能确认行为保持稳定。
- 每轮结束后,审查该轮改动,并运行足以验证改动的最小检查。避免把所有清理工作合并成一份差异再审查。
- 将技术栈变更、依赖迁移和架构调整分别作为独立任务处理,除非这些改动是完成本次清理所必需的。
开始重构前,您可以使用规划模式制定重构计划。
使用 ExecPlans
代码现代化实践指南介绍了 ExecPlans。这类文档可以帮助 Codex 跟踪整体清理进度,明确清理完成后代码应达到的状态,并记录每轮验证的结果。 如果重构涉及多个模块,或需要分多次会话完成,ExecPlans 尤其有用。您可以在其中记录删除了哪些代码、更新了哪些写法、哪些契约必须保持稳定,以及哪些事项仍待后续处理。
用技能复用清理方法
如果多个代码仓库、服务或团队都遵循相同的清理规则,可以使用技能。有适用于特定框架的技能时,请优先使用。对于风险较高的清理工作,请加入安全和 CI 技能。如果您的团队已有经过验证的检查清单,用于删除未使用的代码、提取模块或更新旧式写法,请据此创建团队技能。 如果您需要在多个代码库中进行同样的现代化改造,Codex 可以帮助您把首次成功改造的做法整理成可复用的技能。
相关使用场景
创建 Codex 能用的 CLI
请 Codex 创建一个可组合使用的 CLI。Codex 可以在任意文件夹中运行它,将它与代码仓库中的脚本配合使用,用它下载文件,并通过配套技能记住它的用法。
开发网页游戏
让 Codex 根据游戏设计概要制定清晰的开发计划,再按计划做出可玩的网页游戏。使用 imagegen 生成美术素材,让 Codex 在真实浏览器中试玩,逐步改进游戏操控和界面。
执行代码迁移
使用 Codex 梳理旧系统与新技术栈的对应关系,按里程碑推进迁移,并在每次切换前验证新旧系统的行为是否一致。