概览
使用 Codex 通过小而易审查的步骤移除无用代码、梳理大型文件、合并重复逻辑,并更新过时模式。
适合场景
- 适用于存在无用代码、过大的模块、重复逻辑或过时抽象,导致日常修改成本高昂的代码库。
- 适用于需要在原地完成代码现代化,而不把这项工作演变为框架迁移或技术栈迁移的团队。
以小步推进现代化
对这个代码库进行现代化和重构。 要求: - 除非我明确要求功能变更,否则保持行为不变。 - 首先识别无用代码、重复路径、过大的模块、过时抽象,以及拖慢变更的遗留模式。 - 对于每个提议的改造步骤,说明当前行为、结构性改进,以及用于证明行为保持稳定的验证检查。 - 将工作拆分为小而易审查的重构步骤,例如删除无用代码、简化控制流、提取辅助函数,或用仓库当前约定替换过时模式。 - 保持公共 API 稳定,除非重构本身要求变更。 - 明确指出哪些框架迁移、依赖升级、API 变更或架构调整应拆分为单独的迁移任务。 - 如果工作范围较大,先提出我们在实现前应创建的文档、规范和一致性检查。 请提出一个执行计划。
简介
当你的代码库累积了未使用代码、重复逻辑、过时抽象、大型文件或遗留模式,导致每一次改动的成本都高于应有水平时,就应该考虑通过重构来减少工程债务。重构的核心是在不把现有系统变成一次技术栈迁移的前提下,改善其结构形态。
Codex 在这里很有用,因为它可以先梳理混乱区域,再通过小而易审查的步骤完成清理:删除未使用路径、拆解大型模块、合并重复路径、更新旧框架模式,并为每一步加强验证。
目标是在原地改进当前代码库:
- 移除不再需要的未使用代码、过时辅助函数、旧标记和兼容性垫片。
- 通过提取辅助函数、拆分组件或将副作用移动到更清晰的边界,缩小嘈杂模块的规模。
- 用仓库当前约定替换遗留模式:更新的框架原语、更清晰的类型、更简单的状态流,或标准库工具。
- 在保持公开行为稳定的同时,让下一次变更成本更低。
使用方法
- 在编辑前让 Codex 先梳理该区域:嘈杂模块、重复逻辑、未使用代码、测试、公共契约,以及仓库已经不再适用的旧模式。
- 一次只选择一个清理主题:移除未使用代码、简化控制流、将过时模式现代化,或将大文件拆分为更小且职责明确的部分。
- 在 Codex 修改文件之前,先让它说明当前行为、它想做的结构性改进,以及能够证明行为保持稳定的最小检查。
- 每一步之后都审查并运行最小且有意义的检查,而不是把整个清理工作一次性合并成一个 diff。
- 除非完成清理必须依赖这些变更,否则应将技术栈变更、依赖迁移和架构调整作为独立任务处理。
你可以在开始 工作之前使用 Plan mode 为这次重构制定计划。
利用 ExecPlans
代码现代化 cookbook 介绍了 ExecPlans:这类文档可以让 Codex 持续掌握清理工作的整体情况,明确预期终态,并记录每一步之后的验证结果。 当重构跨越多个模块或需要多个会话才能完成时,它们尤其有用。你可以用它们来记录删除内容、模式更新、必须保持稳定的契约,以及哪些事项仍被延期。
使用 skills 处理可复用模式
当相同的清理规则会在多个仓库、服务或团队中重复出现时,技能 就非常有用。可优先使用特定框架的 skill(如果可用),为高风险清理配套安全和 CI skills,并在你拥有一套经过验证的未使用代码清理、模块提取或遗留模式现代化检查清单时,创建团队 skill。 如果你最终需要在多个代码库中执行同一种现代化改造步骤,Codex 可以帮助你把第一次成功的改造沉淀为可复用的 skill。
