Acceder al contenido principal

Un apunte sobre buenas prácticas de programación para desarrollar módulos en Drupal 8.

Volver a Blog

Un apunte sobre buenas prácticas de programación para desarrollar módulos en Drupal 8.

20 Oct 016
Código drupal
Avatar Carlos Burgueño

Drupal

Como sabéis, Drupal es una plataforma de código abierto apoyada en una gran comunidad de desarrolladores, que se encargan de mantener y extender sus funcionalidades. La comunidad de Drupal es quizás la pieza más importante del conjunto, ya que el esfuerzo y el trabajo de estas personas contribuye a un sistema más versátil y seguro.

Y esta comunidad no es exclusiva, cualquiera puede (y debería) formar parte de ella aportando su granito de arena: revisiones, test, traducciones, módulos, sugerencias, tutoriales,... La lista de formas de hacerlo es muy amplia.

Por empezar por alguna parte, si estáis pensando en desarrollar algún módulo para un proyecto Drupal y os gustaría compartirlo con la comunidad, para que forme así parte de su ecosistema, podéis empezar por echar un vistazo al documento que expone las normas de codificación (Coding standards) que debe tener cualquier módulo de Drupal para que pueda ser aceptado y usado por la comunidad.

En este documento se describe cómo debe estar escrito tu código para que sea interpretado de forma más sencilla por otros desarrolladores, así como para realizar test, correcciones de bugs, mejoras, etc... Son unas normas de estilo de programación que se aplican a todos los módulos y permiten crear un poco de orden en todo este universo de código.

A modo de resumen, en el documento te indican por ejemplo como deben ser elementos como:

  • Indentación y espacios: separación, inicio y final de los bloques, etc...
  • Operadores: cómo representarlos, su separación.
  • Estructuras de control: bucles, condicionales if..then,etcc
  • Longitud de la línea y salto: en general, no podrán sobrepasar los 80 caracteres
  • Definición y llamadas a funciones
  • Matrices
  • Utilización de las comillas
  • Concatenación de cadenas
  • Comentarios

Etc, etc, etc...

Aunque en un principio puede parece abrumador tanto esfuerzo, lo cierto es que compensa y una vez te hayas acostumbrado no supone demasiado trabajo.

Aún así, existen diversas herramientas que automatizan este proceso y te ayudar a validar si tu código cumple con estos estándares, indicándote por ejemplo si has cometido errores y cómo corregirlos.

Si utilizáis entornos de desarrolllo como PhpStorm por ejemplo, se puede definir y configurar un esquema "Drupal" con las indicaciones necesarias para que, si aplicas este esquema a un proyecto, se aplicarán estas normas de forma automática. Podéis echar un ojo a este enlace o a este otro.

Del mismo modo, para validar si tu código cumple con estos estándares, puedes hacerlo cómodamente con esta herramienta online: pareview.sh La herramienta accederá a tu repositorio de código y realizará una evaluación de cómo está escrito. Una vez finalice su examen, te mostrará por pantalla un informe con las posibles correcciones que debas hacer.

Ya tenéis el primer paso para empezar a contribuir a la comunidad de Drupal. Cuidado, que engancha!

 

 

 

Comentarios

Añadir nuevo comentario