For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Navegação principal
Theme
Codex

Codex use case

Refatore sua base de código

Remova código morto e modernize padrões legados sem alterar o comportamento do código.

Difficulty Advanced
Time horizon 1h

Use o Codex para remover código morto, reorganizar arquivos grandes, unificar trechos de lógica duplicada e atualizar padrões ultrapassados em etapas pequenas e fáceis de revisar.

Best for

  • Bases de código em que código morto, módulos grandes demais, lógica duplicada ou abstrações ultrapassadas tornam até as alterações de rotina mais trabalhosas.
  • Equipes que precisam modernizar o código existente sem transformar o trabalho em uma migração de framework ou de stack.

Contents

    ← All use cases

    Refatore sua base de código

    Remova código morto e modernize padrões legados sem alterar o comportamento do código.

    Use o Codex para remover código morto, reorganizar arquivos grandes, unificar trechos de lógica duplicada e atualizar padrões ultrapassados em etapas pequenas e fáceis de revisar.

    Advanced
    1h

    Use o Codex para remover código morto, reorganizar arquivos grandes, unificar trechos de lógica duplicada e atualizar padrões ultrapassados em etapas pequenas e fáceis de revisar.

    Advanced
    1h

    Best for

    • Bases de código em que código morto, módulos grandes demais, lógica duplicada ou abstrações ultrapassadas tornam até as alterações de rotina mais trabalhosas.
    • Equipes que precisam modernizar o código existente sem transformar o trabalho em uma migração de framework ou de stack.

    Skills & Plugins

    • Ao concluir cada etapa da modernização, revise as alterações de limpeza de código que possam afetar a segurança, as mudanças nas dependências, os fluxos de autenticação e as superfícies expostas antes de integrar as alterações.
    • Transforme um padrão de modernização já validado, uma lista de verificação para revisões ou um fluxo de verificação de paridade em uma habilidade que possa ser reutilizada no repositório ou pela equipe.
    Skill Why use it
    Security Best Practices Ao concluir cada etapa da modernização, revise as alterações de limpeza de código que possam afetar a segurança, as mudanças nas dependências, os fluxos de autenticação e as superfícies expostas antes de integrar as alterações.
    Skill Creator Transforme um padrão de modernização já validado, uma lista de verificação para revisões ou um fluxo de verificação de paridade em uma habilidade que possa ser reutilizada no repositório ou pela equipe.

    Starter prompt

    Modernize e refatore esta base de código. Requisitos: - Preserve o comportamento do código, a menos que eu peça explicitamente uma alteração funcional. - Comece identificando código morto, caminhos de execução duplicados, módulos grandes demais, abstrações ultrapassadas e padrões legados que atrasam as alterações. - Para cada etapa proposta, descreva o comportamento atual, a melhoria estrutural e a verificação que deve confirmar que o comportamento foi preservado. - Divida a refatoração em etapas pequenas e fáceis de revisar, como remover código morto, simplificar o fluxo de controle, extrair funções auxiliares ou substituir padrões ultrapassados pelas convenções atuais do repositório. - Mantenha as APIs públicas estáveis, a menos que a refatoração exija alguma mudança. - Destaque qualquer migração de framework, atualização de dependência, alteração de API ou mudança de arquitetura que deva ser tratada em uma tarefa de migração separada. - Se o escopo for amplo, indique quais documentos, especificações e verificações de paridade devemos criar antes da implementação. Proponha um plano para realizar esse trabalho.
    Modernize e refatore esta base de código. Requisitos: - Preserve o comportamento do código, a menos que eu peça explicitamente uma alteração funcional. - Comece identificando código morto, caminhos de execução duplicados, módulos grandes demais, abstrações ultrapassadas e padrões legados que atrasam as alterações. - Para cada etapa proposta, descreva o comportamento atual, a melhoria estrutural e a verificação que deve confirmar que o comportamento foi preservado. - Divida a refatoração em etapas pequenas e fáceis de revisar, como remover código morto, simplificar o fluxo de controle, extrair funções auxiliares ou substituir padrões ultrapassados pelas convenções atuais do repositório. - Mantenha as APIs públicas estáveis, a menos que a refatoração exija alguma mudança. - Destaque qualquer migração de framework, atualização de dependência, alteração de API ou mudança de arquitetura que deva ser tratada em uma tarefa de migração separada. - Se o escopo for amplo, indique quais documentos, especificações e verificações de paridade devemos criar antes da implementação. Proponha um plano para realizar esse trabalho.

    Introdução

    Quando a base de código acumula código sem uso, lógica duplicada, abstrações obsoletas, arquivos grandes ou padrões legados, cada alteração pode exigir mais esforço do que deveria. Nesse caso, considere refatorar o código para reduzir a dívida técnica. O objetivo da refatoração é melhorar a estrutura do sistema existente sem transformar o trabalho em uma migração de tecnologias.

    O Codex pode primeiro mapear a área que precisa de atenção e depois fazer a limpeza em pequenas etapas, fáceis de revisar. Em cada etapa, ele pode remover caminhos de execução sem uso, reorganizar módulos grandes, unificar caminhos duplicados ou modernizar padrões antigos do framework, além de tornar a validação mais rigorosa.

    Para melhorar a base de código atual, siga estas orientações.

    1. Remova código sem uso, funções auxiliares obsoletas, flags antigas e camadas de compatibilidade que já não são necessárias.
    2. Reduza o tamanho de módulos difíceis de acompanhar. Extraia funções auxiliares, divida componentes ou mova os efeitos colaterais para pontos do código com responsabilidades mais bem definidas.
    3. Substitua padrões legados pelas convenções atuais do repositório, como primitivas mais recentes do framework, tipos mais claros, um fluxo de estado mais simples ou utilitários da biblioteca padrão.
    4. Preserve o comportamento público do sistema e reduza o esforço necessário para a próxima alteração.

    Como usar

    1. Peça ao Codex que, antes de editar os arquivos, mapeie a área e identifique módulos difíceis de acompanhar, lógica duplicada, código sem uso, testes, contratos públicos e padrões antigos que já não atendem às necessidades do repositório.
    2. Escolha um foco por vez para a limpeza. Você pode remover código sem uso, simplificar o fluxo de controle, modernizar um padrão obsoleto ou dividir um arquivo grande em partes menores, cada uma com um responsável definido.
    3. Antes que o Codex altere os arquivos, peça que ele descreva o comportamento atual, a melhoria estrutural que pretende fazer e a verificação mínima que deve confirmar que o comportamento foi preservado.
    4. Após cada etapa, revise as alterações e execute a menor verificação que faça sentido. Evite acumular toda a limpeza em um único diff.
    5. Trate as mudanças na pilha de tecnologias, as migrações de dependências e as alterações de arquitetura como tarefas separadas, a menos que sejam necessárias para concluir a limpeza.

    Você pode usar o Modo Planejar para definir as etapas da refatoração antes de começar o trabalho.

    Use ExecPlans

    O guia prático de modernização de código apresenta os ExecPlans, documentos que permitem ao Codex acompanhar a limpeza como um todo, descrever em detalhes o resultado esperado e registrar os resultados da validação após cada etapa. Eles são úteis quando a refatoração abrange mais de um módulo ou exige mais de uma sessão. Use esses documentos para registrar o que foi removido, quais padrões foram atualizados, quais contratos precisaram ser preservados e o que ficou para depois.

    Use habilidades para tarefas recorrentes

    As Habilidades são úteis quando as mesmas regras de limpeza se aplicam a vários repositórios, serviços ou equipes. Use habilidades específicas do framework quando estiverem disponíveis e acrescente habilidades de segurança e de integração contínua nas limpezas que envolvem risco. Crie uma habilidade para a equipe quando já tiver uma lista de verificação testada para remover código sem uso, extrair módulos ou modernizar padrões legados. Se você precisar repetir a mesma etapa de modernização em mais de uma base de código, o Codex pode ajudar a transformar a primeira execução bem-sucedida em uma habilidade reutilizável.

    Related use cases