For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Navigation principale
Codex

Codex use case

Refactorisez votre base de code

Supprimez le code mort et modernisez les patterns hérités sans modifier le comportement.

Difficulty Avancé
Time horizon 1 h

Utilisez Codex pour supprimer le code mort, restructurer les fichiers volumineux, factoriser la logique dupliquée et moderniser les patterns obsolètes en procédant par petites étapes faciles à examiner.

Idéal pour

  • Bases de code comportant du code mort, des modules surdimensionnés, de la logique dupliquée ou des abstractions obsolètes qui rendent les modifications courantes coûteuses.
  • Équipes qui doivent moderniser le code sur place sans transformer ce travail en migration de framework ou de stack.

Contents

    ← Tous les cas d’utilisation

    Refactorisez votre base de code

    Supprimez le code mort et modernisez les patterns hérités sans modifier le comportement.

    Utilisez Codex pour supprimer le code mort, restructurer les fichiers volumineux, factoriser la logique dupliquée et moderniser les patterns obsolètes en procédant par petites étapes faciles à examiner.

    Avancé
    1 h

    Utilisez Codex pour supprimer le code mort, restructurer les fichiers volumineux, factoriser la logique dupliquée et moderniser les patterns obsolètes en procédant par petites étapes faciles à examiner.

    Avancé
    1 h

    Idéal pour

    • Bases de code comportant du code mort, des modules surdimensionnés, de la logique dupliquée ou des abstractions obsolètes qui rendent les modifications courantes coûteuses.
    • Équipes qui doivent moderniser le code sur place sans transformer ce travail en migration de framework ou de stack.

    Skills et plugins

    • Passez en revue les opérations de nettoyage ayant une incidence sur la sécurité, les changements de dépendances, les flux d’authentification et les surfaces exposées avant de fusionner les modifications d’une étape de modernisation.
    • Transformez un pattern de modernisation éprouvé, une liste de contrôle de révision ou un workflow de contrôle de parité en Skill réutilisable à l’échelle d’un dépôt ou d’une équipe.
    Skill Why use it
    Security Best Practices Passez en revue les opérations de nettoyage ayant une incidence sur la sécurité, les changements de dépendances, les flux d’authentification et les surfaces exposées avant de fusionner les modifications d’une étape de modernisation.
    Skill Creator Transformez un pattern de modernisation éprouvé, une liste de contrôle de révision ou un workflow de contrôle de parité en Skill réutilisable à l’échelle d’un dépôt ou d’une équipe.

    Prompt de démarrage

    Modernisez et refactorisez cette base de code. Exigences : - Préservez le comportement, sauf si je demande explicitement une modification fonctionnelle. - Commencez par repérer le code mort, les chemins dupliqués, les modules surdimensionnés, les abstractions obsolètes et les patterns hérités qui ralentissent les modifications. - Pour chaque étape proposée, indiquez le comportement actuel, l’amélioration structurelle et le contrôle de validation censé démontrer que le comportement est resté stable. - Décomposez le travail en petites étapes de refactorisation faciles à examiner, par exemple pour supprimer le code mort, simplifier le flux de contrôle, extraire des fonctions utilitaires ou remplacer les patterns obsolètes par les conventions actuelles du dépôt. - Maintenez les API publiques stables, sauf si la refactorisation exige une modification. - Signalez toute migration de framework, mise à niveau de dépendance, modification d’API ou changement d’architecture qui devrait faire l’objet d’une tâche de migration distincte. - Si le travail est de grande ampleur, proposez la documentation, les spécifications et les contrôles de parité que nous devrions créer avant l’implémentation. Proposez un plan pour y parvenir.
    Modernisez et refactorisez cette base de code. Exigences : - Préservez le comportement, sauf si je demande explicitement une modification fonctionnelle. - Commencez par repérer le code mort, les chemins dupliqués, les modules surdimensionnés, les abstractions obsolètes et les patterns hérités qui ralentissent les modifications. - Pour chaque étape proposée, indiquez le comportement actuel, l’amélioration structurelle et le contrôle de validation censé démontrer que le comportement est resté stable. - Décomposez le travail en petites étapes de refactorisation faciles à examiner, par exemple pour supprimer le code mort, simplifier le flux de contrôle, extraire des fonctions utilitaires ou remplacer les patterns obsolètes par les conventions actuelles du dépôt. - Maintenez les API publiques stables, sauf si la refactorisation exige une modification. - Signalez toute migration de framework, mise à niveau de dépendance, modification d’API ou changement d’architecture qui devrait faire l’objet d’une tâche de migration distincte. - Si le travail est de grande ampleur, proposez la documentation, les spécifications et les contrôles de parité que nous devrions créer avant l’implémentation. Proposez un plan pour y parvenir.

    Introduction

    Lorsque votre base de code a accumulé du code inutilisé, de la logique dupliquée, des abstractions obsolètes, des fichiers volumineux ou des patterns hérités qui rendent chaque modification plus coûteuse qu’elle ne devrait l’être, vous devriez envisager de réduire cette dette technique par une refactorisation. La refactorisation vise à améliorer la structure du système existant sans pour autant en faire une migration de stack.

    Codex est utile dans ce cas, car il peut d’abord cartographier la zone problématique, puis effectuer le nettoyage par petites étapes faciles à examiner : supprimer les chemins inutilisés, restructurer les modules volumineux, factoriser les chemins dupliqués, moderniser les anciens patterns de framework et renforcer les contrôles de validation associés à chaque étape.

    L’objectif est d’améliorer directement la base de code existante :

    1. Supprimez le code inutilisé, les fonctions utilitaires obsolètes, les anciens flags et les couches de compatibilité qui ne sont plus nécessaires.
    2. Allégez les modules surchargés en extrayant des fonctions utilitaires, en scindant des composants ou en déplaçant les effets de bord vers des limites plus clairement définies.
    3. Remplacez les patterns hérités par les conventions actuelles du dépôt : primitives plus récentes du framework, types plus clairs, flux d’état plus simple ou utilitaires de la bibliothèque standard.
    4. Préservez la stabilité du comportement public tout en réduisant le coût de la prochaine modification.

    Utilisation

    1. Demandez à Codex de cartographier la zone avant toute modification : les modules surchargés, la logique dupliquée, le code inutilisé, les tests, les contrats publics et tous les anciens patterns qui ne sont plus adaptés au dépôt.
    2. Choisissez un seul axe de nettoyage à la fois : suppression du code inutilisé, simplification du flux de contrôle, modernisation d’un pattern obsolète ou scission d’un fichier volumineux en parties plus petites dont la responsabilité est clairement attribuée.
    3. Avant que Codex n’apporte des modifications aux fichiers, demandez-lui d’indiquer le comportement actuel, l’amélioration structurelle envisagée et le contrôle minimal qui permettra de vérifier que le comportement est resté stable.
    4. Après chaque étape, passez les modifications en revue et exécutez le contrôle minimal pertinent, plutôt que de regrouper tout le nettoyage dans un seul diff.
    5. Traitez les changements de stack, les migrations de dépendances et les évolutions d’architecture comme des tâches distinctes, sauf s’ils sont nécessaires pour terminer le nettoyage.

    Vous pouvez utiliser le Mode plan pour créer un plan de refactorisation avant de commencer le travail.

    Tirez parti des ExecPlans

    Le guide pratique de modernisation du code présente les ExecPlans : des documents qui permettent à Codex de conserver une vue d’ensemble du nettoyage, de décrire précisément l’état final visé et de consigner les résultats de validation après chaque étape. Ils sont utiles lorsque la refactorisation s’étend à plusieurs modules ou nécessite plusieurs sessions. Utilisez-les pour consigner les suppressions, les mises à jour de patterns, les contrats qui devaient rester stables et les éléments encore reportés.

    Utilisez les Skills pour les pratiques récurrentes

    Les Skills sont utiles lorsque les mêmes règles de nettoyage s’appliquent à plusieurs dépôts, services ou équipes. Utilisez des Skills spécifiques au framework lorsqu’ils sont disponibles, associez des Skills de sécurité et de CI aux nettoyages risqués et créez un Skill d’équipe lorsque vous disposez d’une liste de contrôle éprouvée pour la suppression du code inutilisé, l’extraction de modules ou la modernisation de patterns hérités. Si vous en venez à appliquer la même étape de modernisation à plusieurs bases de code, Codex peut vous aider à transformer la première étape menée à bien en Skill réutilisable.

    Cas d’utilisation associés