19Nov

Cómo aplicar la guía de estilo de PSR-1 y PSR-2 automáticamente en tu proyecto de PHP con la librería FriendsOfPHP/PHP-CS-Fixer

El estándar PSR-1 y PSR-2 son guías de estilo de programación muy aceptadas en el mundo PHP. El uso de estas guías permiten homogeneizar el código entre diferentes equipos de programación y hacerlo más legible.

PHP-CS-FIXER es una herramienta para aplicar estas dos guías de estilo a nuestros archivos PHP automáticamente.

Instalando PHP-CS-FIXER

Para instalarlo de forma global en nuestro sistema operativo, con un usuario root ejecutamos el siguiente grupo de comandos:

wget https://github.com/FriendsOfPHP/PHP-CS-Fixer/releases/download/v1.12.4/php-cs-fixer.phar -O /usr/local/bin/php-cs-fixer
chmod +x /usr/local/bin/php-cs-fixer

Ahora, desde cualquier punto de nuestro sistema podemos comprobar le instalación de la librería mirando si está accesible el ejecutable:

php-cs-fixer --version

Arreglando los archivos PHP

Para la prueba vamos a usar un archivo PHP como el siguiente:

Sample.php

<?php
namespace Simple;

class SampleClass implements \ArrayAccess, \Countable {

}

Sobre el archivo, ejecutando el comando de php-cs-fixer como sigue:

php-cs-fixer fix Sample.php

Modificará el archivo de clase Sample.php para cumplir las guías de estilo:

<?php

namespace Simple;

class Sample implements \ArrayAccess, \Countable
{
}

Vemos que ha cambiado el nombre de clase para que sea igual que el archivo y ha arreglado según la guía de estilo los corchetes de clase y saltos de línea.

Podemos ejecutar php-cs-fixer de forma recursiva en una carpeta para todos sus archivos:

php-cs-fixer fix src/SomeNamespace

Librería FriendsOfPHP/PHP-CS-FIXER en Github: https://github.com/FriendsOfPHP/PHP-CS-Fixer

https://github.com/FriendsOfPHP/PHP-CS-Fixer

Leave a comment