Improvement - General - Integrar herramienta Rector

[jordiSTIC]

Descripción

Previo al PR #315 de actualización del core de SuiteCRM, se estima oportuno incluir en SinergiaCRM la herramienta "Rector" con el objetivo de poderla pasar en las instancias y poderse anticipar a posibles errores en el código personalizado de éstas debido al cambio de versión de php

Instalación de Rector

Se ha instalado la herramienta "Rector" en el directorio SticInclude/vendor/rector-standalone, mediante 'composer'

Scripts

Se han creado dos scripts para ejecutar en las instancias:

• SticInclude/rector/UpdateToPhp8RectorCheck.php: Script a ejecutar en las instancias para pasar Rector
• SticInclude/rector/SticRectorConfig.php: Configuración de las acciones a realizar con Rector en las instancias

Características del script:

• Se ejecutará en la carpeta custom y en las carpetas de modules que no estén incluidas en SinergiaCRM, es decir, los módulos propios de cada instancia
• Ejecutará un conjunto de reglas "básicas" para detectar y corregir posibles errores con PHP 8 (no se aplican muchas reglas definidas como "best-practices" ya que pueden modificar mucho código de forma innecesaria)
• Si hay errores o cambios propuestos, se generará un fichero con el resultado y los cambios propuestos en el directorio raíz de sinergiaCRM con el nombre rectorOutput.html (no incluirá cambios de formato)
• Si se ejecuta con el parámetro adapt-code modifica el código de los ficheros, aplicando los cambios

Rector en custom

Se ha ejecutado el script en el código de la carpeta custom. Alguno de los cambios aplicados son de formato en algunas tabulaciones de inicio de línea

Pruebas

1. Verificar los cambios realizados en custom
2. En terminal, ejecutar php SticInclude/rector/UpdateToPhp8RectorCheck.php
3. Verificar que no propone modificaciones de código

[ManuSinergiaCRM]

Probado en los siguientes escenario:

1. Con la instancia limpia --> No genera el fichero
2. Con un módulo recien construido --> No genera el fichero
3. Con un módulo recien construido y modificado para tener dos variables con var en vez de public --> Encontrados los dos errores
4. Escenario 3 + modificaciones en módulos STIC y SUITE --> Encontrados los dos errores del Escenario 3

[AlbertoSTIC]

Aprobado

[github-actions]

Actions executed at: 2024-11-20 09:57:42.