Recherche…
Définir le style de code pour un projet
PhpStorm propose des paramètres par défaut pour un style de code pour un grand nombre de langues, basé sur les meilleures pratiques et les normes communes. Mais vous pouvez personnaliser le style pour chaque langue sur une base par projet dans les paramètres PhpStorm> Editor > Style de code .
Les schémas
Les schémas sont des ensembles de directives et de paramètres de style de code. Vous pouvez sélectionner un schéma pour un projet et celui-ci sera appliqué instantanément. Il existe également un schéma de projet disponible uniquement lorsque vous avez un projet ouvert. Le schéma de projet n'enregistre pas les instructions dans les paramètres utilisateur généraux, mais dans les propres paramètres du projet.
Si vous cliquez sur le bouton Gérer, vous pouvez ajouter un nouveau schéma pour configurer rapidement un nouvel ensemble de directives de style de code. La case Gérer peut également être utilisée pour exporter ou importer des schémas, ce qui est très utile si vous souhaitez partager des schémas avec vos amis ou collègues.
Changer le style pour une langue spécifique
Pour modifier les paramètres de style de code pour une langue spécifique, cliquez simplement sur la langue disponible dans la barre latérale. Vous serez alors présenté une page de paramètres différente pour chaque langue.
Par exemple, le langage PHP aura des paramètres pour les onglets et les espaces, les accolades ou les documents PHP.
Si vous voulez savoir ce que chaque paramètre différent signifie, vous pouvez les rechercher dans la documentation officielle.
Documentation Style Code pour PhpStorm 2016 et plus
Appliquer un style de code spécifié pour un projet à plusieurs membres de l'équipe
Actuellement, il n'existe pas de méthode de clic unique pour appliquer des directives de style de code dans une équipe, mais il existe deux méthodes pour vous assurer qu'un certain style de code est appliqué à votre produit.
Importer des schémas de style de code PhpStorm
La première et la plus simple des solutions consiste à configurer un schéma de code sur votre propre instance PhpStorm, à exporter le schéma sur un lecteur portable ou un lecteur réseau et à importer le schéma sur toutes les machines de développement.
De cette façon, un développeur peut facilement utiliser les raccourcis clavier Cmd + Shift + L (MacOS) ou Ctl + Alt + L (Windows / Linux) pour formater automatiquement le code source complet.
Vous trouverez des informations plus détaillées à ce sujet dans la documentation suivante:
Reformatage du code source dans PhpStorm 2016 et plus
Les inconvénients
Malheureusement, il est impossible de vérifier si un développeur a réellement appliqué le reformatage du code. Vous devez vous fier aux promesses des développeurs pour qu’ils s’occupent du reformatage.
Vérification automatique du format de code avec un serveur CI
Une façon très stricte de contrôler le formatage du code source consiste à implémenter un serveur d'intégration continue tel que Jenkins , capable de vérifier si le code source correspond à un style de code prédéfini.
Supposons qu'un développeur ait travaillé sur une nouvelle fonctionnalité sur sa propre branche de développement et souhaite transférer ses modifications vers le référentiel principal. D'abord, il pousse les modifications sur sa propre branche où la nouvelle fonctionnalité sera vérifiée par le serveur CI. Si la vérification a échoué parce que le code n'est pas correctement formaté, le développeur en sera informé afin de pouvoir corriger les problèmes.
Il existe différentes manières de configurer la qualité du code et les contrôles de formatage avec tous les différents serveurs d'intégration. Il est donc nécessaire d'expliquer comment configurer un serveur avec des contrôles dans les balises correspondantes.
Définir les styles de code à partir d'une norme prédéfinie comme PSR-2
PhpStorm est déjà livré avec un grand nombre de schémas de langage prédéfinis basés sur des directives de style de code commun et des normes telles que PSR-2 . Il y a une sorte de fonctionnalité cachée dans les pages de paramètres de style de code où vous pouvez importer ces normes et les définir comme votre configuration actuelle. Pour ce faire, choisissez simplement votre langage de codage dans le panneau de gauche. Ensuite, il y a un petit lien en haut à droite appelé Set from ...
En cliquant sur ce lien, PhpStorm vous présentera un petit popup dans lequel vous pourrez choisir parmi les standards prédéfinis sous l'onglet Style prédéfini .
