{"id":27656,"date":"2021-05-12T09:30:00","date_gmt":"2021-05-12T06:30:00","guid":{"rendered":"https:\/\/themewp.inform.click\/?p=27656"},"modified":"2021-10-17T17:13:55","modified_gmt":"2021-10-17T14:13:55","slug":"mejore-sus-estandares-de-codificacion-de-laravel-usando-grumphp","status":"publish","type":"post","link":"https:\/\/themewp.inform.click\/es\/mejore-sus-estandares-de-codificacion-de-laravel-usando-grumphp\/","title":{"rendered":"Mejore sus est\u00e1ndares de codificaci\u00f3n de Laravel usando GrumPHP"},"content":{"rendered":"

No importa si eres un desarrollador experimentado o un novato, debes mejorar tus est\u00e1ndares de codificaci\u00f3n para convertirte en un mejor desarrollador. Ya sea que est\u00e9 trabajando solo o con un equipo, siempre es una buena pr\u00e1ctica tener las mismas convenciones de codificaci\u00f3n durante todo el proyecto. Pero mantener los mismos est\u00e1ndares en todos los lugares no es f\u00e1cil si lo estamos verificando manualmente. Puede suceder que no cumpli\u00f3 con el est\u00e1ndar incluso si decidi\u00f3 seguirlo. Es un error humano, a veces pasamos por alto cosas que no deber\u00edamos. Para evitar estos problemas, debemos automatizar nuestro flujo de trabajo. Al hacerlo, nuestro sistema automatizado se encargar\u00e1 de la tarea que le hemos asignado y el 99,99% de las veces nunca falla.<\/p>\n

GrumPHP<\/a> es una biblioteca que vigila<\/a> cada confirmaci\u00f3n de git. Si su c\u00f3digo no sigue los est\u00e1ndares dados, la biblioteca no le permite confirmar el c\u00f3digo. Primero debe corregir su c\u00f3digo y luego solo usted podr\u00e1 comprometerse con Git.<\/p>\n

\u00bfSuena bien? Ve\u00e1moslo en acci\u00f3n.<\/p>\n

Empezando<\/h3>\n

Como estamos hablando de los est\u00e1ndares de codificaci\u00f3n de Laravel, debe tener una configuraci\u00f3n de proyecto de Laravel. Si no lo tiene, inst\u00e1lelo con el comando:<\/p>\n

composer create-project --prefer-dist laravel\/laravel laravel-dev<\/code><\/pre>\n
Aqu\u00ed ‘laravel-dev’ es el nombre de su proyecto. Abra la terminal en el directorio ra\u00edz de su proyecto e inicialice el git.<\/p>\n
git init<\/code><\/pre>\n
Es obligatorio tener Git en tu proyecto para poder aprovechar GrumPHP. Aqu\u00ed es donde funciona. Cuando instalamos GrumPHP, crea un gancho dentro de la .git<\/code>carpeta y luego vigila cada confirmaci\u00f3n.<\/p>\n
Ahora, agregue y confirme sus archivos actuales en el git usando los comandos a continuaci\u00f3n uno por uno.<\/p>\n
git add -A<\/code><\/pre>\n
git commit -m 'initial commit'<\/code><\/pre>\n
Mejorar el est\u00e1ndar de codificaci\u00f3n Laravel usando GrumPHP<\/h3>\n
Una vez que tengamos la configuraci\u00f3n de git en nuestro proyecto Laravel, estamos listos para instalar la biblioteca GrumPHP. Para instalarlo, ejecute el siguiente comando:<\/p>\n
composer require --dev phpro\/grumphp<\/code><\/pre>\n
Una vez que el paquete est\u00e9 instalado, deber\u00eda ver el siguiente mensaje en la terminal:<\/p>\n
\u00a1Cuidado! \u00a1GrumPHP est\u00e1 olfateando tus confirmaciones!<\/p>\n
Significa que el paquete se instal\u00f3 correctamente. A continuaci\u00f3n, abra el grumphp.yml<\/code>archivo y agregue el siguiente c\u00f3digo en \u00e9l.<\/p>\n
parameters:\n\u00a0\u00a0\u00a0\u00a0git_dir:. \u00a0\u00a0\u00a0\u00a0bin_dir: vendor\/bin\n\u00a0\u00a0\u00a0\u00a0tasks: { \n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0phpcs: {\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0standard: PSR2\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0}\n\u00a0\u00a0\u00a0\u00a0\u00a0}<\/code><\/pre>\n
En el c\u00f3digo anterior, la parte importante es la l\u00ednea standard: PSR2<\/code>. Aqu\u00ed, le estamos diciendo a GrumPHP que verifique las convenciones de codificaci\u00f3n de PSR2 con los archivos que se van a confirmar. Usamos PSR2 aqu\u00ed porque Laravel sigue los est\u00e1ndares de codificaci\u00f3n de PSR2. Despu\u00e9s de esto, GrumPHP realizar\u00eda su tarea y nos informar\u00eda sobre el error en una consola si lo encontrara.<\/p>\n
Si no ha instalado la biblioteca est\u00e1ndar de codificaci\u00f3n, ejecute el siguiente comando para instalarla:<\/p>\n
composer require \"squizlabs\/php_codesniffer=*\"<\/code><\/pre>\n
Esta biblioteca tiene est\u00e1ndares de codificaci\u00f3n PSR2 incluidos en su n\u00facleo. Por lo tanto, GrumPHP verificar\u00e1 su c\u00f3digo de Laravel con el PSR2 y le sugerir\u00e1 cambios si no est\u00e1 siguiendo los est\u00e1ndares de PSR2.<\/p>\n
Digamos que tenemos un ImageController.php<\/code>archivo en nuestro proyecto y tenemos el siguiente c\u00f3digo en \u00e9l.<\/p>\n
public function store(Request $request)\n{\n\u00a0\u00a0\u00a0\u00a0if($request->hasFile('profile_image')) {\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\/\/get filename with extension\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$filenamewithextension = $request->file('profile_image')->getClientOriginalName();\n\u00a0\u00a0\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\/\/get filename without extension\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$filename = pathinfo($filenamewithextension, PATHINFO_FILENAME);\n\u00a0\u00a0\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\/\/get file extension\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$extension = $request->file('profile_image')->getClientOriginalExtension();\n\u00a0\u00a0\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\/\/filename to store\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$filenametostore = $filename.'_'.time().'.'.$extension;\n\u00a0\u00a0\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\/\/Upload File\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$request->file('profile_image')->storeAs('public\/profile_images', $filenametostore);\n\u00a0\u00a0\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0if(!file_exists(public_path('storage\/profile_images\/crop'))) {\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0mkdir(public_path('storage\/profile_images\/crop'), 0755);\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0}\n\u00a0\u00a0\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\/\/ crop image\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$img = Image::make(public_path('storage\/profile_images\/'.$filenametostore));\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$croppath = public_path('storage\/profile_images\/crop\/'.$filenametostore);\n\u00a0\u00a0\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$img->crop($request->input('w'), $request->input('h'), $request->input('x1'), $request->input('y1'));\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$img->save($croppath);\n\u00a0\u00a0\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\/\/ you can save crop image path below in database\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$path = asset('storage\/profile_images\/crop\/'.$filenametostore);\n\u00a0\u00a0\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0return redirect('image')->with(['success' => \"Image cropped successfully.\", 'path' => $path]);\n\u00a0\u00a0\u00a0\u00a0}\n}<\/code><\/pre>\n
A continuaci\u00f3n, intente confirmar el c\u00f3digo anterior y deber\u00eda ver un resultado como el siguiente:<\/p>\n
Proporciona el error de codificaci\u00f3n en detalles junto con el n\u00famero de l\u00ednea y la descripci\u00f3n. Tambi\u00e9n puede notar la l\u00ednea:<\/p>\n
PHPCBF PUEDE ARREGLAR LAS 2 VIOLACIONES MARCADAS DEL SNIFF AUTOM\u00c1TICAMENTE<\/p>\n
C\u00f3mo utilizar el comando PHPCBF<\/h3>\n
Al ejecutar un comando PHPCBF, podemos corregir algunos errores autom\u00e1ticamente. Dir\u00edgete al directorio ‘vendor \/ bin’ desde la terminal y ejecuta el siguiente comando para corregir los errores usando PHPCBF.<\/p>\n
PHPCBF --standard=PSR2 PATH_TO_YOUR_CONTROLLER<\/code><\/pre>\n
Reemplace el marcador de posici\u00f3n con los valores reales. Probablemente, si est\u00e1 ejecutando este comando en Git bash, obtendr\u00e1 el error ‘bash: phpcbf: command not found’. En ese caso, ejecute este comando en el s\u00edmbolo del sistema de Windows. En nuestro caso, vemos la siguiente salida en el terminal.<\/p>\n
Tenga en cuenta que PHPCBH no resuelve todos los errores. A veces tambi\u00e9n es necesario resolver el error manualmente. Ahora, cuando intente confirmar el c\u00f3digo, deber\u00eda obtener el mensaje de \u00e9xito y el c\u00f3digo tambi\u00e9n se comprometi\u00f3.<\/p>\n
Pensamientos finales<\/h3>\n
En este tutorial, hemos discutido c\u00f3mo mejorar los est\u00e1ndares de codificaci\u00f3n de Laravel usando GrumPHP. Pero no se limita solo a Laravel. Tambi\u00e9n puede utilizar esta biblioteca en sus otros CMS, Frameworks. Estamos usando la biblioteca GrumPHP para nuestros proyectos principales de Laravel, WordPress y PHP. Realmente nos ayuda a mantener nuestro estilo de codificaci\u00f3n de manera consistente.<\/p>\n
Art\u00edculos relacionados<\/h4>\n