En el mundo del desarrollo de software, mantener un código limpio y coherente es tan crucial como su funcionalidad. Para los desarrolladores que se inician en la programación PHP, trabajar con un estilo de código consistente puede parecer una tarea desalentadora, especialmente en proyectos grandes o cuando se colabora en equipos. Aquí es donde PHP-CS-Fixer se convierte en una herramienta indispensable. Este artículo proporciona una introducción a PHP-CS-Fixer, junto con guías de configuración específicas para proyectos Symfony y Laravel, dos de los frameworks PHP más populares.
¿Qué es PHP-CS-Fixer?
PHP-CS-Fixer, abreviatura de PHP Coding Standards Fixer, es una herramienta de desarrollo que ayuda a los programadores a seguir los estándares de codificación PHP. Automatiza el proceso de corrección de estilo de código para cumplir con las normas definidas, como PSR-1, PSR-2, y muchas otras configuraciones personalizables. Es especialmente útil para proyectos grandes y equipos de desarrollo, donde mantener un estilo de código uniforme es esencial para la legibilidad y mantenimiento del código.
Instalación de PHP-CS-Fixer
La forma más sencilla de instalar PHP-CS-Fixer es a través de Composer, el gestor de dependencias para PHP. Puedes instalarlo globalmente (para que esté disponible en cualquier proyecto) o localmente dentro de un proyecto específico. Para una instalación global, ejecuta:
composer require --dev friendsofphp/php-cs-fixer
Configuración para Symfony
Symfony sigue un conjunto estricto de estándares de codificación, y PHP-CS-Fixer puede configurarse para adherirse automáticamente a estos estándares. Para configurar PHP-CS-Fixer en un proyecto Symfony, crea un archivo de configuración .php-cs-fixer.dist.php en la raíz de tu proyecto con el siguiente contenido:
<?php
$finder = PhpCsFixer\Finder::create()
->in(__DIR__.'/src')
->name('*.php')
->exclude('var')
->exclude('vendor');
$config = new PhpCsFixer\Config();
return $config->setRules([
'@Symfony' => true,
'array_syntax' => ['syntax' => 'short'],
])
->setFinder($finder);Este archivo configura PHP-CS-Fixer para corregir archivos PHP dentro del directorio src, excluyendo los directorios var y vendor. Se aplican las reglas de Symfony junto con la sintaxis de array corta.
Configuración para Laravel
Laravel no tiene un conjunto de estándares de codificación tan estrictos como Symfony, pero seguir las buenas prácticas de codificación mejora la calidad del código. Para configurar PHP-CS-Fixer en un proyecto Laravel, puedes usar una configuración similar, adaptándola a las convenciones de Laravel:
<?php
$finder = PhpCsFixer\Finder::create()
->in([
__DIR__.’/app’,
__DIR__.’/config’,
__DIR__.’/routes’,
__DIR__.’/tests’,
])
->name(‘*.php’);
$config = new PhpCsFixer\Config();
return $config->setRules([
‘@PSR2’ => true,
‘binary_operator_spaces’ => [
‘default’ => ‘align_single_space_minimal’,
],
‘array_syntax’ => [‘syntax’ => ‘short’],
‘not_operator_with_successor_space’ => true,
])
->setFinder($finder);
Ejecución de PHP-CS-Fixer
Para correr PHP-CS-Fixer y corregir automáticamente los archivos según la configuración definida, ejecuta:
composer run fix o php-cs-fixer fix
Aprende a instalar y configurar esta herramienta esencial con nuestras guías paso a paso. ¿Buscas mejorar aún más tus habilidades en PHP? No te pierdas nuestro post sobre las mejores prácticas de PHP con PHPStan en nuestro blog. ¡Eleva la calidad de tu código hoy!
Enlaces de interes
https://styde.net/organizar-codigo-php-cs-fixer-siguiendo-los-estandares-psr/
https://phpdev.es/php/quality-tools/php-cs-fixer/
Desarrollador de software con más de 7 años de experiencia, especializado en desarrollo web y backend. Con habilidades demostradas en PHP, Laravel, Symfony, y una amplia gama de tecnologías modernas. Apasionado por el diseño y desarrollo de software.
