Cómo excluir archivos de PHP CodeSniffer

Cuando trabaja con PHP CodeSniffer y lo hace en la terminal, es probable que busque generar errores en algo que no sea su IDE.

Quiero decir, si ese fuera el caso, simplemente lo tendrías ejecutándote en tu editor, ¿verdad?

Pero hay momentos en los que puede estar interesado en encontrar los problemas en el código de otras personas. Tal vez sea una dependencia, tal vez sea una pieza de software de terceros, o tal vez sea un favor.

Cualquiera sea el caso, si configuró el directorio del proyecto de una manera que usa Composer para incluir PHP CodeSniffer y está usando los Estándares de codificación de WordPress, entonces es probable que necesite excluir archivos de PHP CodeSniffer cuando ejecute el programa.

Y así es como puedes hacer eso.

Antes de ingresar a los comandos que son necesarios, supongo que tiene una configuración de directorio similar a esta:

Una estructura de directorio potencial.

Es decir, tienes:

• un montón de archivos PHP (y subdirectorios que contienen archivos PHP),
• un archivo composer.json para traer PHP CodeSniffer al proyecto
• un directorio de proveedores que incluye las dependencias para PHP CodeSniffer

Si tiene instalados los estándares de codificación de WordPress pero no los tiene configurados para PHP CodeSniffer, emita este comando:

$ ./vendor/bin/phpcs --config-set installed_paths ~/path/to/wpcs

Así que aquí está el problema:

Desea excluir archivos de PHP CodeSniffer, pero tiene muchos archivos para rastrear (es decir, desde que introdujo el directorio de proveedores). ¿Cómo excluimos archivos de PHP CodeSniffer sin dejar de obtener los resultados que queremos?

Necesita algunos comandos adicionales:

1. asegúrese de haber incluido los estándares de codificación de WordPress como parte de la configuración,
2. decirle explícitamente a PHP CodeSniffer que use el estándar de WordPress
3. decirle a PHP CodeSniffer qué directorios ignorar y qué archivos procesar

¿Suena complicado? El comando es muy fácil:

$ ./vendor/bin/phpcs --ignore=*/vendor/* --standard=WordPress .

Y la terminal debería terminar luciendo así:

El resultado neto de olfatear solo archivos PHP para el directorio actual.

En este punto, debería poder ver los errores en su terminal (esperemos que no haya ninguno, ¿verdad? 😏) o puede canalizarlos a otro archivo para revisarlos en otra aplicación o en una fecha posterior.