La herramienta PHP Coding Standards Fixer (PHP CS Fixer) corrige su código para seguir los estándares; ya sea que desee seguir los estándares de codificación PHP definidos en PSR-1, PSR-2, etc., u otros impulsados por la comunidad como el de Symfony. También puedes definir el estilo de tu equipo a través de la configuración.
Puede modernizar su código (como convertir la función pow
al operador **
en PHP 5.6) y optimizarlo (micro).
Si ya está utilizando un linter para identificar problemas de estándares de codificación en su código, sabrá que solucionarlos a mano es tedioso, especialmente en proyectos grandes. Esta herramienta no sólo los detecta, sino que también los soluciona.
Nota Cada nueva versión de PHP requiere un gran esfuerzo para admitir la nueva sintaxis. Es por eso que es posible que la última versión de PHP aún no sea compatible. Si lo necesita, considere apoyar el proyecto de cualquier forma conveniente, por ejemplo, contribuyendo con código o revisando los RP existentes. Para ejecutar PHP CS Fixer en versiones aún no compatibles "bajo su propio riesgo", aproveche PHP_CS_FIXER_IGNORE_ENV.
La forma recomendada de instalar PHP CS Fixer es usar Composer en un archivo composer.json
dedicado en su proyecto, por ejemplo en el directorio tools/php-cs-fixer
:
mkdir -p tools/php-cs-fixer
composer require --working-dir=tools/php-cs-fixer friendsofphp/php-cs-fixer
O usando el composer.json
principal:
composer require --dev friendsofphp/php-cs-fixer
Para obtener más detalles y otros métodos de instalación, consulte las instrucciones de instalación.
Puede utilizar imágenes de Docker prediseñadas para ejecutar php-cs-fixer
.
docker run -it --rm -v $(pwd):/code ghcr.io/php-cs-fixer/php-cs-fixer:${FIXER_VERSION:-3-php8.3} fix src
$FIXER_VERSION
usado en el ejemplo anterior es un identificador de una versión que desea usar, que se basa en las versiones de Fixer y PHP combinadas. Hay diferentes etiquetas para el nivel SemVer de cada Fixer y la versión de PHP con sintaxis <php-cs-fixer-version>-php<php-version>
. Por ejemplo:
3.57.0-php7.4
3.57-php8.0
3-php8.3
Suponiendo que instaló PHP CS Fixer como se indicó anteriormente, puede ejecutar el siguiente comando para reparar los archivos PHP en el directorio src
:
tools/php-cs-fixer/vendor/bin/php-cs-fixer fix src
Consulte el uso, la lista de reglas integradas, la lista de conjuntos de reglas y la documentación del archivo de configuración para obtener más detalles.
Si necesita aplicar estilos de código que no son compatibles con la herramienta, puede crear reglas personalizadas.
Existen complementos dedicados para:
PHP CS Fixer se mantiene en GitHub en https://github.com/PHP-CS-Fixer/PHP-CS-Fixer. Allí se aceptan informes de errores e ideas sobre nuevas funciones.
Puede comunicarse con nosotros en las Discusiones de GitHub sobre el proyecto, configuración, posibles mejoras, ideas y preguntas. ¡Visítenos allí!
La herramienta viene con bastantes solucionadores integrados, pero todos son más que bienvenidos a contribuir con más de ellos.