Vérifier la syntaxe avec CodeSniffer

1. Introduction

Tout au long de ce livre, nous avons régulièrement insisté sur l’utilisation des conventions de CakePHP et leurs avantages dans le développement d’une application. Afin de s’assurer de la bonne utilisation des conventions CakePHP et des normes de développement PSR-1 et PSR-2 (cf. chapitre Avant de démarrer), nous allons désormais réaliser un audit complet du code développé au travers de nos exemples grâce au plugin CakePHP CodeSniffer.

Ce plugin repose sur la librairie PHP CodeSniffer, dont la documentation complète est disponible à cette adresse : http://pear.php.net/manual/en/package.php.php-codesniffer.php

2. Installation du plugin CakePHP CodeSniffer

Voici la ligne de commande à utiliser afin d’installer ce plugin en utilisant Composer :

composer require --dev "cakephp/cakephp-codesniffer=2.*"
 

En complément, il est nécessaire d’indiquer à la libraire PHP CodeSniffer où se trouvent les règles de CakePHP grâce à la commande suivante :

vendor/bin/phpcs --config-set installed_paths 
vendor/cakephp/cakephp-codesniffer
 

3. Utilisation

Il suffit désormais d’utiliser la commande phpcs sur les fichiers et répertoires de notre choix afin d’obtenir un rapport complet sur les erreurs de développement.

Syntaxe :

vendor/bin/phpcs --standard=CakePHP /mon/dossier
 

Exemple de...