English
主导航
Codex

Codex 用例

重构你的代码库

在不改变行为的前提下,清除死代码并使遗留模式现代化。

难度 高级
时间周期 1h

使用 Codex 清除死代码、梳理臃肿的文件、合并重复逻辑,并通过小型且易于审查的迭代将陈旧的模式现代化。

适用场景

  • 包含死代码、超大模块、重复逻辑或陈旧抽象,导致日常修改成本高昂的代码库。
  • 需要就地现代化代码,但又不想将工作演变成框架或技术栈迁移的团队。

目录

    ← 所有用例

    重构你的代码库

    在不改变行为的前提下,清除死代码并使遗留模式现代化。

    使用 Codex 清除死代码、梳理臃肿的文件、合并重复逻辑,并通过小型且易于审查的迭代将陈旧的模式现代化。

    高级
    1h

    使用 Codex 清除死代码、梳理臃肿的文件、合并重复逻辑,并通过小型且易于审查的迭代将陈旧的模式现代化。

    高级
    1h

    适用场景

    • 包含死代码、超大模块、重复逻辑或陈旧抽象,导致日常修改成本高昂的代码库。
    • 需要就地现代化代码,但又不想将工作演变成框架或技术栈迁移的团队。

    技能与插件

    • 在合并现代化修改之前,审查涉及安全敏感的清理、依赖项变更、身份验证流程以及暴露的接口。
    • 将经过验证的现代化模式、审查清单或一致性工作流,转化为可复用的代码库或团队技能。
    技能 为什么使用它
    安全最佳实践 在合并现代化修改之前,审查涉及安全敏感的清理、依赖项变更、身份验证流程以及暴露的接口。
    技能创建器 将经过验证的现代化模式、审查清单或一致性工作流,转化为可复用的代码库或团队技能。

    起始提示词

    对该代码库进行现代化和重构。要求:- 除非我明确要求功能变更,否则请保持行为不变。- 首先识别死代码、重复路径、超大模块、陈旧抽象,以及拖慢修改进度的遗留模式。- 对于每一次提议的迭代,说明当前行为、结构性改进,以及用于证明行为保持稳定的验证检查。- 将工作拆分为小且易于审查的重构迭代,例如删除死代码、简化控制流、提取辅助函数,或使用代码库当前的约定替换过时的模式。- 保持公共 API 稳定,除非重构本身需要对其进行变更。- 明确指出任何应拆分为独立迁移任务的框架迁移、依赖升级、API 变更或架构调整。- 如果工作范围较广,请提议在实施之前我们需要创建的文档、规范和一致性检查。并为此制定一份计划。
    对该代码库进行现代化和重构。要求:- 除非我明确要求功能变更,否则请保持行为不变。- 首先识别死代码、重复路径、超大模块、陈旧抽象,以及拖慢修改进度的遗留模式。- 对于每一次提议的迭代,说明当前行为、结构性改进,以及用于证明行为保持稳定的验证检查。- 将工作拆分为小且易于审查的重构迭代,例如删除死代码、简化控制流、提取辅助函数,或使用代码库当前的约定替换过时的模式。- 保持公共 API 稳定,除非重构本身需要对其进行变更。- 明确指出任何应拆分为独立迁移任务的框架迁移、依赖升级、API 变更或架构调整。- 如果工作范围较广,请提议在实施之前我们需要创建的文档、规范和一致性检查。并为此制定一份计划。

    简介

    当你的代码库积累了未使用的代码、重复的逻辑、陈旧的抽象、庞大的文件或遗留模式,导致每一次修改的成本都高于应有的水平时,你应该考虑通过重构来减少工程债务。重构旨在改善现有系统的结构,而不是将其转变为一次技术栈迁移。

    Codex 在这里非常有用,因为它可以首先映射出混乱的区域,然后以小型且易于审查的迭代完成清理:删除未使用的路径、梳理庞大的模块、合并重复的路径、使旧的框架模式现代化,并加强每次迭代的验证。

    目标是就地改善当前的代码库:

    1. 删除不再需要的未使用代码、过时的辅助函数、旧的标记和兼容性垫片。
    2. 通过提取辅助函数、拆分组件或将副作用转移到更清晰的边界来缩小臃肿的模块。
    3. 用代码库当前的约定替换遗留模式:更新的框架原语、更清晰的类型、更简单的状态流或标准库实用程序。
    4. 在降低未来修改成本的同时,保持公共行为稳定。

    如何使用

    1. 在编辑之前,让 Codex 映射出相关区域:臃肿的模块、重复的逻辑、未使用的代码、测试、公共契约,以及代码库中任何已经过时的旧模式。
    2. 一次只选择一个清理主题:删除未使用的代码、简化控制流、使过时的模式现代化,或将庞大的文件拆分为更小、职责更清晰的组件。
    3. 在 Codex 修改文件之前,让它先说明当前行为、它想要进行的结构改进,以及能够证明行为保持稳定的最小化检查。
    4. 在每次迭代之后审查并运行最小可用检查,而不是将整个清理工作打包成一次大规模的差异提交。
    5. 将技术栈变更、依赖迁移和架构调整作为独立任务处理,除非它们是完成清理所必需的。

    你可以使用 Plan mode 在开始工作之前创建重构计划。

    利用 ExecPlans

    The 代码现代化手册 引入了 ExecPlans:这些文档让 Codex 能够全局掌控清理工作,阐明预期的最终状态,并在每次迭代后记录验证结果。当重构跨越多个模块或需要多个工作会话时,它们非常有用。你可以使用它们来记录删除操作、模式更新、必须保持稳定的契约,以及被推迟处理的事项。

    为可重复的模式使用 skills

    技能 当相同的清理规则在多个代码库、服务或团队中重复时,skills 非常有用。在可用时使用特定框架的 skills,在具有风险的清理工作周围添加安全和 CI 的 skills,并在你拥有经过验证的未使用代码删除、模块提取或遗留模式现代化清单时,创建一个团队 skill。如果你最终在多个代码库中执行相同的现代化迭代,Codex 可以帮助将第一次成功的迭代转化为可复用的 skill。

    相关用例