Ajout de plusieurs normes de codage avec Composer

C’est une chose d’utiliser PHP CodeSniffer manuellement, mais si vous utilisez un utilitaire tel que GrumPHP pour vérifier votre travail avant de le valider dans le référentiel, vous voudrez probablement utiliser la version que vous installez avec votre projet.

Cela suppose que :

1. Vous installez PHP CodeSniffer localement sur votre projet,
2. Vous souhaitez installer un ensemble spécifique de normes de codage à exécuter sur votre code.

N’oubliez pas que cela se fait également dans le contexte de vouloir exécuter des scripts automatisés pendant le processus de validation et dans un environnement local (par opposition à un paramètre global) avec Composer.

Composer offre la possibilité d’écrire des scripts pendant l’exécution. Du manuel :

Un script, selon les termes de Composer, peut être soit un rappel PHP (défini comme une méthode statique), soit n’importe quelle commande exécutable en ligne de commande. Les scripts sont utiles pour exécuter le code personnalisé d’un package ou des commandes spécifiques au package pendant le processus d’exécution de Composer.

Pour installer plusieurs normes de codage avec Composer afin que nous puissions faire ce que nous avons avec GrumPHP et tout processus de pré-commit, nous devons tirer parti des scripts pre-install-cmd et pre-update-cmd. Cela garantira que les normes de codage appropriées sont définies pour le binaire au niveau du projet de PHP CodeSniffer.

Exemple :

"scripts": {
    "post-install-cmd": [
        ""vendor/bin/phpcs" --config-set installed_paths /Users/tommcfarlin/Sync/Projects/wpcs/WordPress"
    ],
    "post-update-cmd":  [
        ""vendor/bin/phpcs" --config-set installed_paths /Users/tommcfarlin/Sync/Projects/wpcs/WordPress"
    ],
},

Notez que dans l’exemple ci-dessus, je m’assure d’ajouter les normes de codage WordPress à PHP CodeSniffer.

Mais vous pouvez ajouter plusieurs versions de normes de codage, comme ceci :

"scripts": {
    "post-install-cmd": [
        ""vendor/bin/phpcs" --config-set installed_paths /Users/tommcfarlin/Sync/Projects/wpcs/WordPress-Core,/Users/tommcfarlin/Sync/Projects/wpcs/WordPress-VIP"
    ],
    "post-update-cmd":  [
        ""vendor/bin/phpcs" --config-set installed_paths /Users/tommcfarlin/Sync/Projects/wpcs/WordPress-Core,/Users/tommcfarlin/Sync/Projects/wpcs/WordPress-VIP"
    ],
},

Et vous pouvez ajouter toutes les autres normes que vous avez vous permettant de pointer le script à l’emplacement approprié où ils sont installés.

Une fois cela fait, les standards seront appliqués à PHP CodeSniffer et seront exécutés pendant les processus d’installation et de mise à jour de Composer.