Drupal y CodeSniffer para mantener la calidad del código de nuestros proyectos
CodeSniffer es un script de PHP5 que analiza código PHP para detectar violaciones de un conjunto definido de normas de codificación. Analiza el código fuente para ver si cumple o no con un estándar, ya sea Zend, Pear o uno personalizado.
Junta de Andalucía
CodeSniffer es una herramienta muy sencilla de usar y con uan instalación muy simple que permitirá mantener los estándares de codificación de nuestros proyectos.
La inslatación es muy sencillo, lo primero comprobamos que tengamos instalado CodeSniffer
phpcs -i
Tiene que devolver algo parecido a esta salidad, no exactamente la misma ya que yo ya tengo instalada los estándares de Drupal:
The installed coding standards are Zend, PSR1, PSR12, Squiz, PEAR, MySource, PSR2, Drupal, DrupalPractice and VariableAnalysis
Si no tenemos instalado CodeSniffer lo instalamos:
composer require --dev drupal/core-dev
Y comprobamos que ahora si tengamos instalado el CodeSniffer.
Una vez instalado tenemos que instalar los estándares de código de Drupal:
composer require --dev dealerdirect/phpcodesniffer-composer-installer
Y ya tendríamos instalado lo básico que usar esta herramienta.
Para usar el analizador de CodeSniffer lo ejecutamos de la siguiente manera:
phpcs --standard=Drupal --extensions=php,module web/modules/contrib/
Con esta orden o nos indica que esta todo bien o nos devolverá un informe como el siguiente: