#Introducción
Laravel Pint es un formateador de estilo de código PHP con opiniones definidas para minimalistas. Pint está construido sobre PHP-CS-Fixer y facilita asegurar que el estilo de su código se mantenga limpio y consistente.
Pint se instala automáticamente con todas las nuevas aplicaciones Laravel para que pueda comenzar a usarlo de inmediato. Por defecto, Pint no requiere configuración y corregirá problemas de estilo de código siguiendo el estilo de codificación definido por Laravel.
#Instalación
Pint está incluido en las versiones recientes del framework Laravel, por lo que normalmente no es necesario instalarlo. Sin embargo, para aplicaciones más antiguas, puede instalar Laravel Pint vía Composer:
composer require laravel/pint --dev
#Ejecutando Pint
Puede indicarle a Pint que corrija problemas de estilo de código invocando el binario pint que está disponible en el directorio vendor/bin de su proyecto:
./vendor/bin/pint
También puede ejecutar Pint en archivos o directorios específicos:
./vendor/bin/pint app/Models
./vendor/bin/pint app/Models/User.php
Pint mostrará una lista detallada de todos los archivos que actualiza. Puede ver aún más detalles sobre los cambios de Pint usando la opción -v al invocar Pint:
./vendor/bin/pint -v
Si desea que Pint solo inspeccione su código en busca de errores de estilo sin modificar los archivos, puede usar la opción --test:
./vendor/bin/pint --test
Si desea que Pint modifique únicamente los archivos con cambios no confirmados según Git, puede usar la opción --dirty:
./vendor/bin/pint --dirty
#Configurando Pint
Como se mencionó antes, Pint no requiere configuración. Sin embargo, si desea personalizar los preajustes, reglas o carpetas inspeccionadas, puede hacerlo creando un archivo pint.json en el directorio raíz de su proyecto:
{
"preset": "laravel"
}
Además, si desea usar un pint.json desde un directorio específico, puede proporcionar la opción --config al invocar Pint:
pint --config vendor/my-company/coding-style/pint.json
#Preajustes
Los preajustes definen un conjunto de reglas que se pueden usar para corregir problemas de estilo de código en su código. Por defecto, Pint usa el preajuste laravel, que corrige problemas siguiendo el estilo de codificación definido por Laravel. Sin embargo, puede especificar un preajuste diferente usando la opción --preset en Pint:
pint --preset psr12
Si lo desea, también puede establecer el preajuste en el archivo pint.json de su proyecto:
{
"preset": "psr12"
}
Los preajustes actualmente soportados por Pint son: laravel, per, psr12 y symfony.
#Reglas
Las reglas son directrices de estilo que Pint usará para corregir problemas de estilo en su código. Como se mencionó antes, los preajustes son grupos predefinidos de reglas que deberían ser perfectos para la mayoría de los proyectos PHP, por lo que normalmente no tendrá que preocuparse por las reglas individuales que contienen.
Sin embargo, si lo desea, puede habilitar o deshabilitar reglas específicas en su archivo pint.json:
{
"preset": "laravel",
"rules": {
"simplified_null_return": true,
"braces": false,
"new_with_braces": {
"anonymous_class": false,
"named_class": false
}
}
}
Pint está construido sobre PHP-CS-Fixer. Por lo tanto, puede usar cualquiera de sus reglas para corregir problemas de estilo en su proyecto: PHP-CS-Fixer Configurator.
#Excluyendo archivos / carpetas
Por defecto, Pint inspeccionará todos los archivos .php en su proyecto excepto los que estén en el directorio vendor. Si desea excluir más carpetas, puede hacerlo usando la opción de configuración exclude:
{
"exclude": [
"my-specific/folder"
]
}
Si desea excluir todos los archivos que contengan un patrón de nombre dado, puede hacerlo usando la opción de configuración notName:
{
"notName": [
"*-my-file.php"
]
}
Si desea excluir un archivo proporcionando la ruta exacta al archivo, puede hacerlo usando la opción de configuración notPath:
{
"notPath": [
"path/to/excluded-file.php"
]
}