Code mort en PHP : détecter et supprimer le code inutilisé

Le développement web, tout comme l'entretien d'un jardin, nécessite un entretien régulier pour éviter que des éléments tombés dans l'oubli et inutiles ne s'accumulent et ralentissent vos projets. C'est là qu'intervient le Détecteur de code mort pour PHP, une extension puissante de PHPStan qui aide à identifier et à supprimer le code inutilisé dans les projets PHP. Voici tout ce qu'il faut savoir sur cet outil pratique et ses fonctionnalités clés.

PHPStan : l'outil indispensable pour un code PHP propre

PHPStan est un outil d'analyse statique pour le langage PHP. Pour une présentation complète de ses capacités, notre guide sur PHPStan et l'amélioration de la qualité du code PHP couvre l'installation, les niveaux de règles et les cas d'usage courants. Son objectif principal est de détecter des erreurs dans le code avant même que celui-ci ne soit exécuté. Il agit comme un vérificateur de type avancé en inspectant le code source et en identifiant des problèmes potentiels tels que les incohérences de typage, en détectant des types incorrects ou incompatibles dans les variables, paramètres ou retours de fonctions. Il repère les appels de méthodes inexistantes, avertissant si l'on tente d'appeler une méthode qui n'existe pas dans une classe. Il signale également les propriétés manquantes si elles sont utilisées sans avoir été définies, et identifie des erreurs logiques courantes, comme des conditions toujours vraies ou fausses.

PHPStan est particulièrement utile dans les projets où la robustesse et la maintenance du code sont essentielles. Il fonctionne avec une configuration modifiable, permettant de s'adapter aux normes et contraintes spécifiques d'un projet. En outre, il peut s'intégrer facilement dans les pipelines CI/CD pour automatiser l'analyse et garantir une qualité constante du code. PHPStan 2.0 et son niveau 10 poussent encore plus loin cette rigueur d'analyse.

Qu'est-ce que le code mort ?

Dans le développement logiciel, le code mort, également connu sous le nom de code non utilisé ou code obsolète, désigne des parties de code qui ne sont jamais exécutées ou utilisées dans une application. Ce code peut inclure des fonctions, des méthodes, des classes ou même des blocs de code qui ne sont plus nécessaires pour le fonctionnement du programme. Bien que cela puisse sembler inoffensif, le code mort peut avoir des impacts significatifs sur un projet :

• Évolution du projet : au fur et à mesure que les exigences du projet changent, certaines parties du code deviennent obsolètes.
• Refactorisation : de nouvelles implémentations peuvent rendre certaines parties du code ancien inutiles. Des outils comme Rector automatisent ces transformations et aident à identifier le code devenu superflu.
• Erreurs de développement : parfois, du code est écrit mais jamais utilisé en raison d'erreurs de conception ou de développement.

Impacts du code mort sur un projet

Complexité accrue

Le code mort ajoute une couche de complexité inutile à la base de code. Cela rend le code plus difficile à comprendre et à maintenir, surtout pour les nouveaux développeurs qui rejoignent le projet. La complexité accrue peut également augmenter le risque d'introduire des bugs lors des modifications futures.

Risques de sécurité

Le code mort peut contenir des vulnérabilités qui ne sont pas immédiatement apparentes. Comme il n'est pas utilisé, ces failles CVE peuvent passer inaperçues et rester non corrigées, posant un risque pour la sécurité de l'application.

Performance réduite

Le code mort n'a généralement pas d'impact direct sur les performances à l'exécution : grâce à l'autoloading PSR-4, les classes non utilisées ne sont jamais chargées en mémoire. En revanche, il alourdit les outils de développement : l'analyse statique, les tests, les pipelines CI/CD et les outils de build traitent une base de code plus volumineuse que nécessaire, ce qui rallonge les temps d'exécution de ces processus.

Coûts de maintenance

Maintenir du code mort implique des coûts supplémentaires en termes de temps et de ressources. Les développeurs doivent passer du temps à comprendre et à gérer ce code, ce qui pourrait être mieux utilisé pour améliorer les fonctionnalités existantes ou en ajouter de nouvelles. Cette accumulation non traitée contribue directement à la dette technique, dont les conséquences méritent d'être anticipées.

Dégradation de la qualité du code

La présence de code mort peut dégrader la qualité globale du code. Il peut introduire des incohérences et des contradictions, rendant le code moins fiable et plus sujet aux erreurs.

shipmonk/dead-code-detector : détecter et supprimer le code mort

Qu'est-ce que c'est ?

L'extension shipmonk/dead-code-detector pour PHPStan est un outil puissant conçu pour identifier et supprimer le code PHP inutilisé dans un projet. Ce code peut prendre la forme de fonctions, de classes, de propriétés ou de méthodes qui ne sont jamais appelées ou utilisées. En éliminant ce code superflu, on améliore la lisibilité de la base de code, on réduit sa taille et, par conséquent, on optimise les performances de l'application.

Pourquoi l'utiliser ?

• Amélioration de la maintenabilité : le code devient plus facile à comprendre et à modifier, par soi-même ou par d'autres développeurs.
• Optimisation des performances : moins de code signifie des temps de chargement plus rapides et une utilisation moindre des ressources.
• Sécurité : le code mort peut parfois contenir des vulnérabilités laissées de côté. En le supprimant, on réduit la surface d'attaque de l'application.

Installation

Pour installer cette extension, il faut utiliser Composer :

Copiercomposer require --dev shipmonk/dead-code-detector

L'option --dev indique que cette dépendance est uniquement nécessaire pour le développement, et non pour la production.

Configuration

Une fois installée, il faut inclure les règles de l'extension dans le fichier de configuration PHPStan (généralement phpstan.neon ou phpstan.neon.dist) :

Copierincludes:
  - vendor/shipmonk/dead-code-detector/rules.neon

Cette ligne indique à PHPStan d'inclure les règles de l'extension dans l'analyse du code.

Utilisation

Après avoir configuré l'extension, il suffit d'exécuter PHPStan comme d'habitude. L'extension va alors analyser le code à la recherche de code mort et fournir un rapport détaillé des éléments inutilisés.

Fonctionnalités principales

• Détection de cycles morts : repère les parties de code qui ne sont jamais exécutées.
• Suppression automatique (optionnelle) : certaines extensions permettent de supprimer automatiquement le code mort détecté.

Avantages supplémentaires

• Intégration avec PHPStan : toutes les fonctionnalités de PHPStan sont disponibles, telles que l'analyse de type, la détection des erreurs courantes et la configuration personnalisée.
• Facilité d'utilisation : l'installation et la configuration sont simples, ce qui rend l'extension accessible à tous les développeurs PHP.
• Communauté active : le support et les contributions de la communauté PHPStan enrichissent l'outil en continu.

Conseils supplémentaires

• Exécuter l'analyse régulièrement : intégrer l'analyse PHPStan au processus de développement continu pour détecter rapidement les problèmes.
• Configurer les règles en fonction des besoins : il est possible de personnaliser les règles de l'extension pour adapter l'analyse au projet spécifique.
• Combiner avec d'autres outils : utiliser PHPStan avec d'autres outils de nettoyage de code pour obtenir des résultats encore meilleurs.

Conclusion

En adoptant cette extension, on fait un pas de plus vers un code PHP plus propre, plus efficace et plus facile à maintenir. L'élimination du code mort s'inscrit dans une démarche continue d'amélioration de la qualité et de la performance des projets PHP. C'est aussi une étape indispensable dans un parcours de modernisation applicative pour reprendre un projet en main et reconstruire la confiance de l'équipe dans la codebase. Pour identifier l'ensemble des axes d'amélioration de votre codebase, notre audit de code PHP couvre le code mort, la dette technique et la conformité aux standards.

Pour aller plus loin

• Les 10 erreurs PHPStan niveau max sur Symfony, aller plus loin avec PHPStan niveau 10
• shipmonk/dead-code-detector sur GitHub, l'extension utilisée dans cet article