Installation de plusieurs normes de codage

J’ai parlé de l’importance d’utiliser des normes de codage (quelle que soit la norme que vous choisissez de l’utiliser) et comment configurer PHP CodeSniffer (en particulier avec Visual Studio Code) dans plusieurs articles.

Mais il y a un défi intéressant à relever si vous souhaitez configurer plusieurs normes de codage avec PHPCS. Et ce n’est pas un scénario si étrange non plus.

Imaginez que vous travaillez sur plusieurs projets différents – l’un utilise les normes de codage de WordPress, l’autre utilise PSR2 et l’autre utilise un autre ensemble de règles définies par l’organisation pour laquelle vous travaillez.

Et vous souhaitez tous les ajouter en tant qu’options à votre configuration.

Normes de codage multiples

Pour ce faire, je suppose que vous avez toutes les règles définies dans leurs répertoires. Par exemple, j’ai des ensembles de règles situés dans deux répertoires différents dans mon répertoire Projects (qui se trouve dans Sync ).

1. ~/Sync/Projets/wpcs
2. ~/Sync/Projects/WDS-Coding-Standards

Et installez également PSR2.

Voici le problème : au début, il semblerait que la chose la plus simple à faire pour ajouter plusieurs ensembles de règles en même temps ressemblerait à ceci :

$ phpcs --config-set installed_paths ./wpcs,./WDS-Coding-Standards

Même si les variables d’environnement de votre shell sont correctement prises en compte, cela ne tient pas nécessairement. Au lieu de cela, cela fonctionnera pendant toute la durée de la session shell, mais il ne tiendra pas la prochaine fois que vous ouvrirez votre IDE, votre terminal ou le terminal intégré dans votre IDE, il ne tiendra probablement pas.

Alors que faisons-nous?

Facile : Lorsque vous définissez les chemins d’accès à vos règles, assurez-vous d’utiliser le chemin d’accès complet :

$ phpcs --config-set installed_paths ~/Sync/Projects/wpcs,~/Sync/Projects/WDS-Coding-Standards

Et ça le fait. En supposant que les variables d’environnement sont correctement définies et que vous avez spécifié les chemins appropriés vers vos normes de codage, vous devriez être prêt à partir.