Usar la guía de estilo de Drupal con PhpCS y Visual Code
Cuando trabajamos en el mundo del desarrollo es muy importante definir una guía de estilo y que todo el equipo siga las mismas pautas a la hora de "maquetar" el código fuente.
Drupal mantiene su propia guía de estilo para que todos los que desarrollamos para este CMS sigamos las mismas nomenclaturas, estructuras... Esta guía está disponible en https://www.drupal.org/drupalorg/style-guide.
Aunque es una guía muy fácil de memorizar, siempre es aconsejable contar con herramientas que nos avisen si nos hemos equivocado.
Requisitos previos
Para poder instalar las herramientas y librerías necesarias deberemos contar en nuestro equipo con Composer y Visual Studio Code.
También deberemos añadir a las variables de entorno de Windows los siguientes paths:
- C:\Users\[usuario_windows]\AppData\Roaming\Composer
- C:\Users\[usuario_windows]\AppData\Roaming\Composer\vendor
Sustituiremos la variable [usuario_windows] por el nombre de la carpeta de nuestro usuario.
En algunas ocasiones puede ser necesario añadir también la ruta C:\Users\[usuario_windows]\AppData\Roaming\Composer\vendor\bin a nuestras variables de entorno.
Instalación de PHP CodeSniffer
PHP CodeSniffer es una herramienta de desarrollo esencial que garantiza que su código permanezca limpio y consistente. Su funcionalidad es detectar violaciones de un estándar en archivos PHP, Javascript y CSS.
Para instalarlo haremos lo siguiente:
composer global require "squizlabs/php_codesniffer=*"
Acto seguido actualizaremos el path de phpcs ejecutando el siguiente código:
phpcs --config-set installed_paths C:\Users\[usuario_windows]\AppData\Roaming\Composer\vendor\drupal\coder\coder_sniffer
De la misma manera que hicimos anteriormente sustituiremos la variable [usuario_windows] por el nombre de la carpeta de nuestro usuario.
Instalando la guía de estilo de Drupal
Una vez tenemos instalado phpcs deberemos agregar la guía de estilo de Drupal:
composer global require drupal/coder
Podemos comprobar las guías de estilo que tenemos instaladas en nuestro equipo ejecutando:
phpcs -i
PHPCS en VSCode
Ahora tenemos instalado el coder de Drupal pero deberemos decirle a Visual Studio Code que debe usar la codificación de Drupal.
Para este fin deberemos instalar la extensión phpcs, que nos permite definir el coder a usar.
Ya por último, tendremos que configurar el archivo settings.json para activar esta extensión con el coder de Drupal:
{
"phpcs.enable": true,
"phpcs.standard": "Drupal,DrupalPractice"
}
Recuerda que tienes disponible en https://github.com/oscarnovasf/vscode_config una configuración base para algunos de las extensiones que yo uso habitualmente en mis proyectos.
INFO: El contenido del artículo se adhiere a nuestros principios de ética editorial. Para notificar un error visita nuestro formulario de contacto.