Configurar PHP CodeSniffer(phpcs)

En PHP y otros lenguajes se maneja diferentes convenciones de código, de las cuáles cada framework o librería manejan alguna diferente dependiendo del proyecto o el equipo de desarrollo. Como desarrolladores podemos apoyarnos de estás herramientas llamadas linters, que nos muestran los errores de formato para que cumplamos con el estándar establecido. Es buena idea apegarse a un estándar ya que nos ayuda a escribir código más legible para este tutorial vamos a configurar WordPress para usar el estándar wordpress_core.

Instalar composer de forma global

Descargar el instalador de composer para tu sistema operativo e instalarlo

Instalar php_codesniffer de forma global con composer

composer global require squizlabs/php_codesniffer

Instalar el plugin en VS Code

Puedes instalar el paquete de forma individual bucándolo en las extensiones de VS Code (Ctrl + Shift + X) con el nombre phpcs o instalando la extensión WordPress VS Code Extension Pack que también viene incluida, con el único detalle que la extensión que instala está deprecada porque ya no tendrá mantenimiento.

Ubicaciones de archivos de configuración

Para acceder a los settings desde VS Code puedes entrar a las opciones siguientes del menú:

• En Windows/Linux -  File > Preferences > Settings
• En macOS -  Code > Preferences > Settings

También puedes localizarlos desde la terminal en sus rutas de instalación correspondientes para cada sistema operativo.

• Windows %APPDATA%\Code\User\settings.json
• macOS $HOME/Library/Application\ Support/Code/User/settings.json
• Linux $HOME/.config/Code/User/settings.json

Configurar la ruta de PHP en los settings de VS Code

En los settings de PHP debes de ubicar la ruta de la instalación de PHP que va ocupar el phpcs. Puede saber la ubicación con el comando where php.

// Para windows
"php.validate.executablePath": "C:\\php-instalation-route\\bin\\php\\php.exe",

Configurar la ruta de phpcs en los settings de VS Code

Puedes ejecutar el comando where phpcs para ubicar la ruta donde está instalado phpcs.

Una vez la tengas tienes que agregarla a los settings de VS Code.

// Para windows
"phpcs.executablePath": "C:\\Users\\YourUser\\AppData\\Roaming\\Composer\\vendor\\bin\\phpcs",

Configurar el estándar wordpress_core en VS Code

Finalmente para configurar que estándar de PHP queremos usar, podemos ver cuales tiene preinstalados phpcs con el comando phpcs -i.

The installed coding standards are MySource, PEAR, PSR1, PSR2, PSR12, Squiz, Zend, WordPress, WordPress-Core, WordPress-Docs and WordPress-Extra

Ahora agrega el nombre del estándar en las configuaciones de VS Code.

"phpcs.standard": "WordPress-Core"

En caso de que no este Wordpress-Core te dejo el repositiorio donde debes descargarlo https://github.com/WordPress/WordPress-Coding-Standards , ahí vienen las instrucciones, pero te dejo las que yo seguí.

Recomiendo que lo descargues en la raíz de sistema para que no tenga problemas de lectura.

C:\> git clone -b master https://github.com/WordPress/WordPress-Coding-Standards.git wpcs

C:\Users\YourUser>phpcs --config-set installed_paths C:\wpcs

Config value "installed_paths" added successfully

Vuelves a ejecutar el comando phpcs -i y debe aparecer en la lista el estándar WordPress-Core y ya puedes agregarlo a la configuración de VS Code.

Conclusiones

Configuramos la extensión de PHP CodeSniffer en Visual Studio Code, vimos la importancia de seguir un estándar y como esto nos ayuda a ser mejores desarrolladores, finalmente descubrimos nuevos comandos utiles que nos ayudaron en la configuración.

Hemos llegado al final de este tutorial espero que te haya servido, sin más nos leemos en la próxima, hasta pronto Hacker 🖖.