Retour au Blog

‍Comment PHPStan peut vous aider à améliorer la qualité de votre code PHP ?

‍Comment PHPStan peut vous aider à améliorer la qualité de votre code PHP ?

Qu’est-ce que PHPStan ?

PHPStan est un outil de vérification statique pour le langage de programmation PHP. Il analyse votre code à la recherche d'erreurs et de problèmes potentiels, vous aidant ainsi à améliorer la qualité de votre code et à éviter les erreurs courantes. Tout ça sans écrire le moindre test, tout est automatisé et en plus c'est OpenSource. En l'utilisant dans votre workflow de développement (gitlab-ci par exemple), vous pouvez également remonter les bugs avant que vos projets ne partent en production.

Comment PHPStan fonctionne :

PHPStan est comme un exécutable que vous pouvez installer facilement, il analyse le code PHP source à l'aide d'un analyseur syntaxique et en utilisant des règles de vérification prédéfinies pour détecter les erreurs potentielles. Il peut également utiliser des informations de type pour vérifier que les variables sont utilisées de manière appropriée et qu'il n'y a pas de problèmes de typage.

Il y a une intégration progressive, grâce aux niveaux de règles, ce qui fait que le développeur qui s'y met ne sera pas submergé par des milliers d'erreurs lors de la première exécution. Niveau par niveau, d'autres erreurs arrivent graduellement.

Symfony, Laravel & Drupal sont d'ailleurs les premiers citoyens de cet outil. Il y a des extensions prévues pour chaque Framework populaire. Même le code tirant parti des méthodes et propriétés magiques est bien compris

Comment utiliser PHPStan ?:

PHPStan nécessite PHP >= 7.2. Vous devez l'exécuter dans un environnement avec PHP 7.x mais le code réel n'a pas besoin d'utiliser les fonctionnalités de PHP 7.x. Cet outil fonctionne mieux avec du code orienté objet moderne. Plus votre code est typé, plus vous donnez à PHPStan d'informations avec lesquelles travailler.

Un code correctement annoté et typé (propriétés de classe, arguments de fonction et de méthode, types de retour) aide non seulement les outils d'analyse statique, mais également les autres personnes qui travaillent avec le code à le comprendre.

Puis avec Composer

Pour l'utiliser, vous devez d'abord installer le paquet via Composer en utilisant la commande suivante : composer require --dev phpstan/phpstan. Le lien Github si vous souhaitez en savoir plus.

Ensuite, vous pouvez l'exécuter sur votre code en utilisant la commande suivante : ./vendor/bin/phpstan analyse <dossier de votre projet>  ou faire appel à un fichier de configuration .phpstan.neon pour spécifier les paramètres de votre analyse. Pour apprendre à le configurer, voyez ici.

PHPStan utilise différents niveaux de règles pour analyser le code. Les  niveaux de règles vont de 0 (vérification minimale) à 9 (vérification la plus stricte).

Le choix définitif du niveau de règles dépendra de vos besoins en  matière de qualité de code, des contraintes de temps et de budget et des préférences personnelles de l'équipe de développement. Il est important de tester et de mesurer les résultats de l'analyse à différents niveaux  de règles pour déterminer le niveau de règles optimal pour votre  projet.

Exemple de rapport d’erreur généré par PhpStan

Conclusion :

PHPStan est un outil incontournable pour tout développeur  PHP soucieux de la qualité de son code. Il permet d'analyser automatiquement le code source à la recherche d'erreurs et de problèmes  potentiels, vous aidant ainsi à améliorer la qualité de votre code, à  éviter les erreurs courantes et à faciliter le débogage. En utilisant PHPStan dans votre workflow de développement, vous pouvez également vous  assurer de respecter les conventions de codage et de suivre les meilleures pratiques de programmation. Il est facile à installer et à utiliser, et peut être utilisé pour vérifier à la fois le code de vos projets personnels et de projets open-source. En somme, PHPStan est un  outil efficace pour améliorer la qualité de votre code PHP.

Contactez-nous !
Je veux en savoir plus !