Formato a PHP en Visual Studio Code con PHP CS Fixer
Eres programador de PHP, talvez habrás escuchado de estándares para escribir código que son PSR-1, PSR-2 y PRS-12. PHP CS Fixer nos ayuda de forma fácil a implementarlos o ¿optas por el clásico formato?
function validar(string $email){
... codigo ...
}
Como sea que codifques, aquí te ensesañare como configurar PHP CS Fixer con Visual Studio Code
¿Qué es PSR?
PSR es el acrónimo de PHP Standard recommendation es una guía de estilo de reglas para escribir código fuente de forma coherente y estandarizada. Existen 3 principales estándares. Dejo información más detallada de cada unos en los siguientes enlaces PSR-1, PSR-2, PSR-12, otro que incluye los 3
¿Qué es PHP CS Fixer?
Es una herramienta de línea de comandos que modifica el código para que cumpla con los estándares PSR
Instalación y configuración
1. Crear carpeta de instalación en la raíz de tus proyectos
mkdir -p tools/php-cs-fixer
2. Instalar php-cs-fixer
tools/php-cs-fixer/vendor/bin/php-cs-fixer fix src
3. Uso
tools/php-cs-fixer/vendor/bin/php-cs-fixer fix proyecto/src/Controller/Archivo.php
4. Integración con Visual Studio Code
Crear script.
En /srv/http/tools/php-cs-fixer
crear el archivo .php-cs-fixer.php
con el contenido
setRules([
'@PSR12' => true,
'new_with_braces' => false,
'array_indentation' => true,
'array_syntax' => ['syntax' => 'short'],
'combine_consecutive_unsets' => true,
'multiline_whitespace_before_semicolons' => true,
'single_quote' => true,
'blank_line_before_statement' => true,
'braces' => [
'allow_single_line_closure' => true,
],
'concat_space' => ['spacing' => 'one'],
'declare_equal_normalize' => true,
'function_typehint_space' => true,
'include' => true,
'lowercase_cast' => true,
'no_multiline_whitespace_around_double_arrow' => true,
'no_spaces_around_offset' => true,
'no_unused_imports' => true,
'no_whitespace_before_comma_in_array' => true,
'no_whitespace_in_blank_line' => true,
'object_operator_without_whitespace' => true,
//'single_blank_line_before_namespace' => true,
'blank_lines_before_namespace' => true,
'ternary_operator_spaces' => true,
'trailing_comma_in_multiline' => true,
'trim_array_spaces' => true,
'unary_operator_spaces' => true,
'binary_operator_spaces' => true,
'whitespace_after_comma_in_array' => true,
'single_trait_insert_per_statement' => false,
])
->setLineEnding("\n")
->setIndent(" ");
Instalar extensión
Buscar e instalar la extensión php cs fixer
Configurar extensión
Abrir la configuración de Visual Studio Code y establecer php-cs-fixer.config
con el valor de la ruta del script
5. Dando formato al código
Con esta configuración se aplica automáticamente el formato al salvar el archivo. Pero si deseas aplicarla de forma manual, abre la ventana de comandos y ejecuta php-cs-fixer: fix this file
Listo con esto ya podrás tener tu código php de acuerdo a estandartes. Nos vemos en un próximo post
Tendrás un artículo de como integrar con PHP Storm?
Hola amigo, no uso ese IDE. Pero de acuerdo a la documentación oficial en este paso https://www.jetbrains.com/help/phpstorm/using-php-cs-fixer.html#configure-tool-inspection-composer puedes usar el script que puse en este post