Blog

Drupal Coding Standards, mejorando nuestro código

04/12/2015

Los codings standards de Drupal están basados en PEAR Coding standards. Esta es la página de Drupal.org donde se puede consultar la documentación: https://www.drupal.org/coding-standards

Las normas de codificación nos ayudan a garantizar la coherencia del código contribuido y del que escribimos en nuestros proyectos. Partiendo de un buen principio del desarrollo, “voy a programar pensando en que a quien lea esto después le resulte fácil y claro”, si aplicamos estos coding standards tendremos una distracción menos y nuestros esfuerzos se centrarán en la funcionalidad que estamos desarrollando.

Cómo revisar los Codings Standards

Con Coder utilizando comandos drush

En la documentación del módulo y en la documentación del comando drush podemos encontrar los argumentos y ejemplos.

http://drushcommands.com/drush-7x/coder-review/coder-review

drush coder
Analiza todo el código de nuestro sitio
drush coder nombre_del_modulo
Analiza un módulo concreto

Con Coder utilizando la administración nuestro Drupal

Code review module

Cómo automatizar la revisión (GIT)

Dentro de las buenas prácticas del desarrollo podemos incorporar la realización de la revisión del código de modo automático.

El módulo Drupal Code Quality nos facilita esta tarea, simplemente tenemos que instalar el módulo (PHP_CodeSniffer es requerido) y copiar los ficheros en el directorio .git/hooks de nuestro proyecto. La revisión del código se ejecuta antes del commit, de este modo aseguramos el cumplimiento de los coding standard en nuestro workflow de desarrollo.

Una vez instalado y configurado, cuando modifiquemos nuestro código y hagamos un

git commit -m ‘Mensaje del cambio’ 

se ejecutará el pre-commit y se ejecutará la revisión del código. Si no se cumplen los coding standards se para el commit.

Code Snifeer review

Para realizar un commit sin tener que pasar el coding standard podemos ejecutar:

git commit --no-verify -m ‘Mensaje del commit’

Módulos Drupal y Coding Standards

Vamos a revisar algunos de los principales módulos de Drupal que nos facilitarán la tarea de cumplir los estándares de codificación.

  • Coder es un módulo de revisión de código. Coder es codificador o escritor de código y utilizando un juego de palabras code-r es «code review».
  • Dreditor es un plugin para revisar parches. Muy útil en el proceso de contribución de código en drupal.org
  • PARevview Conjunto de scripts que nos permiten automatizar la revisión del código de proyectos de drupal.org Además se puede utilizar online desde http://pareview.sh
  • Coder Sniffer: Nos permite ejecutar validaciones de los coding standard sin necesidad de tener una instalación Drupal.
  • The Grammar Parser  Esta librería nos facilita el análisis y modificación del código.

Cómo configurar IDEs para cumpimiento de Coding Standards

Configurar PhpStorm

https://confluence.jetbrains.com/display/PhpStorm/Drupal+Development+using+PhpStorm

Configurar Sublime Text

http://realityloop.com/blog/2014/03/05/drupal-development-using-sublime-text-3-5-steps

Configurar Eclipse

https://www.drupal.org/node/75242

Configurar Vim

https://www.drupal.org/project/vimrc y https://www.drupal.org/node/29325

Bonus track

Para ampliar conocimiento y aplicar buenas prácticas a otros aspectos involucrados en el desarrollo, como seguridad, accesibilidad, usabilidad podemos consultar la documentación en drupal.org: https://www.drupal.org/developing/best-practices

También te puede gustar…

Caso de éxito: Fronda

Caso de éxito: Fronda

Fronda, es una cadena de centros de jardinería que cuenta con una tienda online que opera por toda España con la que hemos colaborado.

ASPgems icon
C/ Sextante, 9
28023 Madrid,
España

Hablemos.

A %d blogueros les gusta esto: