PHP_CodeSniffer (phpcs)

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.

Se trata de un instrumento de desarrollo esencial que garantiza que el código se mantiene limpio y consistente. Incluso puede ayudar a evitar algunos errores comunes de semántica realizadas por los desarrolladores.

Ejemplo de uso

A continuación se muestra como funciona la herramienta. Se le puede pasar a uno o varios archivos de manera que devuelva el resultado en función del estándar que le sea indicado. En el ejemplo , se le indica el nombre del fichero

$ phpcs /path/to/code/myfile.inc
$ phpcs /path/to/code/my_dir

y se obtendrá una salida como la siguiente:

$ phpcs /path/to/code/myfile.phpFILE: /path//code/myfile.php
--------------------------------------------------------------------------------
FOUND 5 ERROR(S) AND 1 WARNING(S) AFFECTING 5 LINE(S)-------------------------
 2 | ERROR   | Missing file doc comment
20 | ERROR   | PHP keywords must be lowercase; expected "false" but found
   |         | "FALSE"
47 | ERROR   | Line not indented correctly; expected 4 spaces but found 1
47 | WARNING | Equals sign not aligned with surrounding assignments
51 | ERROR   | Missing function doc comment
88 | ERROR   | Line not indented correctly; expected 9 spaces but found 6
--------------------------------------------------------------------------------