Configuración de PHP CodeSniffer por proyecto

Hace unos años, escribí una publicación sobre cómo configurar PHP CodeSniffer en Visual Studio Code (y también lo actualicé recientemente).

Pero han pasado cuatro años desde que se escribió originalmente esa publicación y, en ese tiempo, muchas cosas pueden cambiar en términos de cómo escribimos código.

Cuatro años es aproximadamente una era de Internet, ¿no es así?

De todos modos, los puntos básicos de ese artículo siguen vigentes, pero si está trabajando en una variedad de proyectos y algunos de ellos requieren diferentes configuraciones, configuraciones y estándares, entonces la forma en que instala y configura PHP CodeSniffer puede ser diferente a cómo lo configura a nivel de sistema.

Entonces, si está en esa posición, así es como puede configurar PHP CodeSniffer por proyecto usando Visual Studio Code.

PHP CodeSniffer por proyecto

Este artículo hace algunas suposiciones:

• Estás familiarizado con Composer ,
• Sabes cómo manejar espacios de trabajo en código,
• Estás familiarizado con PHP CodeSniffer (al menos a nivel global),
• Y sabes cómo trabajar con extensiones de código .

Si no está seguro acerca de alguno de estos, revise este artículo y luego regrese. Te guiaré por el resto.

1 Instale PHP CodeSniffer localmente

Debido a que diferentes proyectos pueden requerir un conjunto diferente de estándares, encuentro útil mantener una copia composer.jsony, naturalmente, composer.lockpor proyecto.

Esto significa que en la raíz de mi proyecto, tengo un composer.jsonarchivo con todo lo que necesito para un proyecto determinado. En el caso de este artículo, necesito una copia de PHP CodeSniffer.

Para instalar PHP CodeSniffer y la última versión de los estándares de codificación de WordPress a nivel de proyecto, crearé el archivo anterior en la raíz de mi proyecto y luego incluiré lo siguiente:

{
    "require": {
        "wp-coding-standards/wpcs": "2.3.0",
        "squizlabs/php_codesniffer": "3.*"
    }
}

En la mayoría de los casos, este archivo será mucho más complejo, pero obtendrá una idea general de lo que debe incluir.

A continuación, ejecute composer instally esto creará un vendordirectorio en su proyecto que incluirá tanto los estándares de codificación de WordPress como el CodeSniffer de PHP.

2 Configurar enlaces simbólicos a los binarios locales

En este punto, puede resultarle útil crear un enlace simbólico a los archivos binarios para PHPCS y PHPCBF para que no entre en conflicto con lo que esté ejecutando a nivel global.

Para ello, en la raíz del proyecto puedes introducir en tu terminal lo siguiente:

$ ln -s /vendor/bin/phpcs phpcs
$ ln -s /vendor/bin/phpcbf phpcbf

Esto le permitirá ejecutar los binarios desde su terminal. Para probar está fuera, intente el siguiente comando:

$ ./phpcs --version

Y deberías ver un resultado como este:

PHP_CodeSniffer version 3.5.5 (stable) by Squiz (http://www.squiz.net)

Si es así, tienes todo configurado correctamente.

3 Instale la extensión PHP CodeSniffer

El siguiente paso, posiblemente el más fácil, es configurar la extensión PHP CodeSniffer en Code. Tiene varias opciones, pero he tenido una buena experiencia con esta extensión en particular.

Una vez que esté instalado y haya recargado su IDE, debería estar listo para instalar y configurar PHP CodeSniffer por proyecto.

4 Configure su espacio de trabajo

En Code, lo siguiente que querrá hacer es configurar PHP Code Sniffer para su proyecto específico. Para hacer esto, es más fácil configurar un espacio de trabajo para su proyecto.

Puede hacer esto haciendo clic en el menú Archivo y luego haciendo clic en el elemento de menú Guardar espacio de trabajo como… . Esto creará un project.code-workspacearchivo dondequiera que opte por incluirlo.

Si está controlando la versión de su proyecto, le recomiendo mantenerlo en la raíz de su proyecto para que pueda mantenerlo en control de versión. Luego, si abre ese archivo, notará que es JSON e incluye una settingsdirectiva. Dentro de esa directiva, agregue la siguiente configuración:

project.code-workspace

Tenga en cuenta que le estamos diciendo explícitamente a la extensión dónde está la ruta del ejecutable, es decir, en el vendordirectorio relativo al workspacearchivo.

Una vez que haya hecho eso, debería poder comenzar a escribir código y hacer que huela activamente su código mientras trabaja.

¿Quieren más?

Si está interesado en una detección y solución de olores y problemas de código aún más agresivos, le recomiendo que consulte el artículo sobre GrumPHP.