Normas de codificación de módulos para PrestaShop

PrestaShop, al ser una plataforma de código abierto, enfatiza la importancia de la consistencia para garantizar un código legible y fácil de mantener. Dado que este código es accedido y manipulado por programadores de todo el mundo, ciertas reglas son cruciales y se deben tener en cuenta para tus desarrollos.

Todo desarrollo adicional dentro de PrestaShop debe pensarse y desarrollarse como un módulo o porción de código que no afecte a la base.

Al programar un módulo, debes prestar atención a varios aspectos importantes sobre todo si quieres poner a la venta tus desarrollos.

En este artículo te voy a destacar los 6 aspectos más relevantes.

Archivos

Debes conocer los requisitos y las normas de codificación de archivos.

Los archivos deben estar en formato UTF-8 sin una marca de orden de bytes (BOM) y con saltos de línea Unix LF.

Además, cada archivo debe terminar con una línea en blanco.

PHP

Necesitas conocer y aplicar el estándar de codificación PSR-2.

Y si deseas trabajar con código moderno usando Symfony, necesitas saber cómo trabajar con el estándar de auto carga PSR-4.

Tipado estricto

El tipado estricto se introdujo hace varios años en la versión 1.7 de PrestaShop.

Requiere que todo el nuevo código sea de tipado estricto. Esto significa que todos los métodos nuevos deben especificar un tipo para todos los parámetros, así como el tipo de retorno. De manera similar, todas las clases nuevas, excepto las interfaces, deben imponer el rigor del tipo mediante declaración.

Una de las primeras cosas que debes hacer en tus archivos PHP es agragar la declaración.

Source code

declare(strict_types=1);

JavaScript

Debemos ceñirnos a los estándares del repositorio de Airbnb en GitHub.

Este repositorio muestra un enfoque mayoritariamente razonable para el código JavaScript. Es un estándar de referencia de como se deben hacer las cosas al momento de usar el lenguaje de programación JavaScript.

HTML y CSS

Para la estructura de las páginas y su diseño, los archivos HTML, CSS (Sass), Twig y Smarty deben seguir los estándares de codificación de Mark Otto, el creador del framework Bootstrap.

Para ayudar a los desarrolladores a cumplir con estas convenciones, se ha configurado Stylelint, un linter de hoja de estilo, en el proyecto PrestaShop. Puede encontrar el archivo de configuración en este repositorio.

Información de licencia

Por último y, no menos importante, aunque parezca una tontería, todos los archivos de PrestaShop deben comenzar con un bloque de licencia de PrestaShop.

Los archivos principales tienen su propio bloque de licencia, mientras que los archivos de los módulos requieren un bloque de licencia específico.

Es posible que hayas encontrado estos bloques de licencia durante tu experiencia con PrestaShop. Si están ahí es por algo.

Para los módulos que desarrolles con al intención de venderlos al público tendrás que agregar lo siguiente en la parte de arriba del fichero:

Source code

/**
 * Copyright since 2007 PrestaShop SA and Contributors
 * PrestaShop is an International Registered Trademark & Property of PrestaShop SA
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Academic Free License version 3.0
 * that is bundled with this package in the file LICENSE.md.
 * It is also available through the world-wide-web at this URL:
 * https://opensource.org/licenses/AFL-3.0
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to license@prestashop.com so we can send you a copy immediately.
 *
 * @author    PrestaShop SA and Contributors <contact@prestashop.com>
 * @copyright Since 2007 PrestaShop SA and Contributors
 * @license   https://opensource.org/licenses/AFL-3.0 Academic Free License version 3.0
 */

En la documentación oficial puedes ver más detalles de los estándares de código de PrestaShop.

Conclusiones

Cada ecosistema o plataforma tiene sus reglas de codificación que se deben respetar y aplicar en tus desarrollos.

Si tu quieres ser un programador admirado y destacado en PrestaShop, a parte de tener unas ideas brillantes, tienes que seguir estas reglas de codificación.

¿Conocías estas reglas? Dame tu opinión en los comentarios.