Desarrollo

Cómo mantener los estándares de código en PHP usando Git.

Durante mi experiencia como desarrollador web, tuve la oportunidad de trabajar con equipos disciplinados que guardaban códigos asombrosos en sus repositorios, así como he trabajado con grupos que no tienen precauciones al escribir sus códigos ya sea por descuido o simplemente por pereza.

Supongo que todos lo hemos hecho y lo entiendo, solo queremos que el código funcione, pero, como escritor de código, es muy importante mantenerlo simple, limpio y especialmente organizado. Además, en estos últimos años, la colaboración desempeña un papel crucial en los equipos de desarrollo a distancia; necesitamos facilitar el trabajo para que otros logren un código de alta calidad.

Esta vez me centraré en PHP, ya que es el que comencé a utilizar sin conocer los estándares. Naturalmente, solía codificar sin ellos y luego me di cuenta de la gran diferencia en el ahorro de tiempo y evitar errores simples.

Aunque PHP nunca ha tenido realmente un estándar uniforme para escribir código; hay una comunidad llamada FriendsOfPHP que se enfoca en mantener los estándares actualizados y facilitar las actividades de codificación.

Hablaré sobre PHP-CS-Fixer, esta herramienta ha hecho que mi día a día sea mucho más simple. Es bien conocido en la comunidad de desarrolladores de PHP, pero nadie habla sobre cómo configurarlo y, cuando lo hacen, es demasiado largo y complicado. En este blog, quiero compartir cómo hacerlo de una manera simple y fácil. Sigue leyendo y descubre paso a paso cómo configurar tus estándares de PSR automáticamente con un simple “commit”.

Ambos son estándares de codificación utilizados para mantener un estilo uniforme, como buena legibilidad y facilidad de mantenimiento; para que la depuración, modificación o adición de nuevas funciones sea mucho más cómoda para el desarrollador.

En este caso, trataremos sólo con los estándares sin profundizar en la implementación de algunos de los patrones de diseño, así como otras buenas prácticas de codificación que requieren un alto conocimiento del patrón utilizado.

Antes de continuar, debemos aclarar que esta es una herramienta de apoyo para corregir pequeños errores o crear el hábito de seguir los estándares, por lo tanto, asegúrese de que su equipo continúe practicando y que esto no genere dependencia de ellos.

Configuración de estándares en PHP

Hice una secuencia de comandos usando un Git Webhook que configura la herramienta y hace innecesario hacer configuraciones o ejecutar comandos adicionales, es decir, después de la instalación solo tienes que "comprometer" tus cambios como lo has hecho hasta ahora. Funciona muy bien para proyectos como Symfony, Laravel, CI, por mencionar algunos. Todos ellos usan estos estándares y puede aplicarlo a otros proyectos, incluso si no están basados en ningún marco y deben seguir el estándar.

Funciona muy bien para proyectos como Symfony, Laravel, CI, por mencionar algunos. Todos ellos usan estos estándares y puede aplicarlo a otros proyectos, incluso si no están basados en ningún marco y deben seguir el estándar.

Ver Caso de Éxito

1. Ejecute el siguiente comando en su terminal:
git clone https://github.com/AgusRdz/php-fixer-pre-commit

Esta carpeta contiene 3 archivos esenciales:
– installer.sh: antes de ejecutarlos, si lo desea, puede verificar el proceso de configuración en detalle.
– config-rules.dist: este es el archivo de reglas para llevar a cabo la estandarización con PSR1 y PSR2.
– pre-commit: instrucciones que se ejecutarán para validar y aplicar las reglas antes del final de la confirmación.

2. Accede a la carpeta con:

cd php-fixer-pre-commit

3. Ejecuta el archivo installer.sh como superusuario

sudo bash installer.sh

4. Accede al repositorio que desea aplicar estos estándares, por ejemplo:

cd ~/Documents/Projects/my-awesome-project-php

git init #if it has not been initialized

5. Ejecuta el siguiente comando

pre-commit-init

Antes de commit, podemos tener un código como el siguiente:

< ?php namespace App;
use XDependency;
use ADependency;
use YDependency;
use BDependency;

class MyClass{
  public function CalculatePrice () {
      $a = 9 ;
     $b= 10 ;
   return $a + $b;
  }
	}
?>

Y luego se habrá aplicado el código PSR1 y PSR2, con un código como el siguiente.

< ?php

namespace App;

use ADependency;
use BDependency;
use XDependency;
use YDependency;

class MyClass
{
    public function CalculatePrice()
    {
        $a = 9;
        $b = 10;

        return $a + $b;
    }
}

Como desarrollador, mantener el código organizado es una de las tareas más difíciles porque a veces consume mucho tiempo; pero es vital crear aplicaciones increíbles y robustas.

Ahora que tiene estas herramientas a su alcance, puede ser más productivo porque todos los pequeños detalles que haya omitido se corregirán automáticamente para obtener un “< br >”. Si lo desea, puede bifurcar este repositorio y crear su versión o colaborar en este haciendo sugerencias para mejorar el proceso.

En ClickIt nos esforzamos por estar a la vanguardia y cumplir con los más altos estándares de desarrollo, puede estar seguro de que su aplicación estará en buenas manos con nosotros.

Joshua Coronado