Laravel Pint: PHP-CS-Fixer para Laravel

Laravel Pint es una herramienta diseñada para mantener el código PHP limpio y consistente, inspirada en PHP-CS-Fixer, una de las herramientas más populares para el formateo de código PHP. Pint está integrado en Laravel, lo que facilita el proceso de aplicar reglas de estilo sin complicaciones.

¿Qué es Laravel Pint?

Laravel Pint es una implementación simplificada de PHP-CS-Fixer, ajustada específicamente para trabajar con las convenciones de estilo de Laravel. Aunque ambos comparten el mismo núcleo, Pint está optimizado para ser fácil de usar y configurado por defecto, sin necesidad de configuraciones adicionales.

Al igual que PHP-CS-Fixer, Pint permite aplicar automáticamente las reglas de estilo de código para asegurar que tu proyecto mantenga una consistencia de formato en todo momento. Pint sigue las mejores prácticas de Laravel, asegurándose de que el código se adhiera a las convenciones de la comunidad Laravel.

Instalación de Laravel Pint

Laravel Pint se instala de manera automática en todas las nuevas aplicaciones de Laravel. Si estás trabajando en una aplicación Laravel desde cero, no necesitas hacer nada, ya que Pint viene preinstalado.

Si estás añadiendo Pint a un proyecto ya existente, puedes instalarlo como dependencia de desarrollo fácilmente ejecutando el siguiente comando:

Usar Laravel Pint

Al ser una herramienta basada en PHP-CS-Fixer, Pint funciona de manera muy sencilla. No necesita configuración inicial; simplemente ejecuta el siguiente comando en la raíz de tu proyecto para empezar a formatear tu código:

Al ejecutar el comando anterior, deberías ver algo similar a lo siguiente:

Este comando escaneará tus archivos PHP y aplicará automáticamente las correcciones necesarias siguiendo el estilo de codificación de Laravel.

En mi caso, ha hecho el fix de todo lo que era necesario en mi proyecto para seguir los estándares de Laravel a nivel de código.

Si deseas ejecutar Pint en un archivo o directorio específico, puedes indicarlo como argumento, por ejemplo:

Personalización (Opcional)

Aunque Laravel Pint viene preconfigurado para seguir el estilo de codificación de Laravel, si quieres personalizar las reglas de formateo, puedes crear un archivo de configuración pint.json en la raíz de tu proyecto. Aquí puedes definir las reglas y ajustes que prefieras.

Un ejemplo de configuración aplicando reglas personalizadas podría ser:

Este archivo permite personalizar cómo deseas que se apliquen las reglas de estilo, similar a cómo se personalizan las reglas de PHP-CS-Fixer.

Integración de Laravel Pint con CI/CD (GitHub Actions)

Una excelente manera de asegurarte de que tu código siempre siga el estilo de Laravel es integrarlo en tu flujo de CI/CD. GitHub Actions es una forma popular de automatizar tareas como esta. A continuación te muestro cómo integrar Laravel Pint en tu pipeline de GitHub Actions.

Crear un archivo de workflow

En tu proyecto, crea un archivo en la siguiente ruta: .github/workflows/lint.yml. Este archivo contiene el flujo de trabajo que se ejecutará en GitHub Actions.

Configurar el Workflow

El siguiente es un ejemplo de cómo configurar un workflow básico para ejecutar Laravel Pint en tu pipeline de CI:

Cada vez que alguien haga un push o cree una pull request, este flujo de trabajo ejecutará Laravel Pint. Si el código no sigue las reglas de estilo de Laravel, el job fallará, asegurando que el código formateado esté siempre conforme a las mejores prácticas.

¿Por Qué Deberías Usar Laravel Pint?

1. Consistencia de Código: Pint garantiza que el código siga el mismo estilo en todo el proyecto, lo que es esencial para la colaboración en equipo y para mantener el código fácil de leer y entender.

2. Facilidad de Uso: Al estar preinstalado en las aplicaciones Laravel y funcionar sin configuración adicional, Pint es extremadamente fácil de usar y de implementar.

3. Minimalismo: Al igual que PHP-CS-Fixer, Pint tiene un enfoque minimalista. No te obliga a configurar opciones complejas, simplemente formatea el código según el estilo de Laravel.

4. Velocidad: Pint es ligero y rápido, lo que permite que puedas aplicarlo de manera rápida en cualquier parte del proyecto, incluso en entornos de integración continua.

5. Integración Perfecta con Laravel: Pint está específicamente diseñado para Laravel, lo que garantiza que las convenciones de estilo se mantengan en línea con las mejores prácticas de la comunidad Laravel.

Conclusión

Laravel Pint es el PHP-CS-Fixer para Laravel, optimizado y listo para usar. No solo facilita el formateo del código en tus proyectos Laravel, sino que también garantiza que todo el equipo mantenga el código limpio y consistente sin complicaciones. Si no lo has probado aún, es una herramienta muy útil para asegurar la calidad y legibilidad de tu código.

No dejes de aprender con nuestras rutas de aprendizaje y lleva tus conocimientos de PHP y Laravel al siguiente nivel:

• Ruta de PHP 8

• Ruta de Laravel 11