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.
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
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.
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.
Related links
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
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.
- Remova código sem uso, funções auxiliares obsoletas, flags antigas e camadas de compatibilidade que já não são necessárias.
- 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.
- 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.
- Preserve o comportamento público do sistema e reduza o esforço necessário para a próxima alteração.
Como usar
- 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.
- 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.
- 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.
- 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.
- 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
Crie jogos de navegador
Use o Codex para transformar a descrição do jogo em um plano bem definido e, em seguida, em...
Crie uma CLI que o Codex possa usar
Peça ao Codex que crie uma CLI que ele possa executar de qualquer pasta, combinar com...
Investigue um incidente e teste uma correção
Forneça ao Codex Cloud um dossiê do incidente sem dados sensíveis e um ambiente de teste...