{"id":27312,"date":"2021-05-12T10:07:00","date_gmt":"2021-05-12T07:07:00","guid":{"rendered":"https:\/\/themewp.inform.click\/?p=27312"},"modified":"2021-10-18T04:15:07","modified_gmt":"2021-10-18T01:15:07","slug":"melhore-seus-padroes-de-codificacao-do-laravel-usando-grumphp","status":"publish","type":"post","link":"https:\/\/themewp.inform.click\/pt-pt\/melhore-seus-padroes-de-codificacao-do-laravel-usando-grumphp\/","title":{"rendered":"Melhore seus padr\u00f5es de codifica\u00e7\u00e3o do Laravel usando GrumPHP"},"content":{"rendered":"

N\u00e3o importa se voc\u00ea \u00e9 um desenvolvedor experiente ou novato, voc\u00ea deve melhorar seus padr\u00f5es de codifica\u00e7\u00e3o para se tornar um desenvolvedor melhor. Quer voc\u00ea esteja trabalhando sozinho ou em equipe, \u00e9 sempre uma boa pr\u00e1tica ter as mesmas conven\u00e7\u00f5es de codifica\u00e7\u00e3o em todo o projeto. Mas manter os mesmos padr\u00f5es em todos os lugares n\u00e3o \u00e9 f\u00e1cil se estivermos verificando manualmente. Pode acontecer de voc\u00ea ter perdido o padr\u00e3o, mesmo que decida segui-lo. \u00c9 um erro humano, \u00e0s vezes perdemos coisas que n\u00e3o dever\u00edamos. Para evitar esses problemas, devemos automatizar nosso fluxo de trabalho. Fazendo isso, nosso sistema automatizado cuidar\u00e1 da tarefa que lhe atribu\u00edmos e em 99,99% das vezes nunca falha.<\/p>\n

GrumPHP<\/a> \u00e9 uma biblioteca que fica de olho em cada commit do git. Se o seu c\u00f3digo n\u00e3o segue os padr\u00f5es fornecidos, a biblioteca n\u00e3o permite que voc\u00ea confirme o c\u00f3digo. Voc\u00ea deve corrigir seu c\u00f3digo primeiro e s\u00f3 ent\u00e3o voc\u00ea pode se comprometer com o Git.<\/p>\n

Soa bem? Vamos ver em a\u00e7\u00e3o.<\/p>\n

Come\u00e7ando<\/h3>\n

Como estamos falando sobre os padr\u00f5es de codifica\u00e7\u00e3o do Laravel, voc\u00ea deve ter uma configura\u00e7\u00e3o de projeto do Laravel. Se voc\u00ea n\u00e3o tiver, instale-o pelo comando:<\/p>\n

composer create-project --prefer-dist laravel\/laravel laravel-dev<\/code><\/pre>\n
Aqui, ‘laravel-dev’ \u00e9 o nome do seu projeto. Abra o terminal no diret\u00f3rio raiz do seu projeto e inicialize o git.<\/p>\n
git init<\/code><\/pre>\n
\u00c9 obrigat\u00f3rio ter Git em seu projeto para aproveitar as vantagens do GrumPHP. \u00c9 aqui que funciona. Quando instalamos o GrumPHP, ele cria um gancho dentro da .git<\/code>pasta e, em seguida, vigia cada commit.<\/p>\n
Agora, adicione e envie seus arquivos atuais para o git usando os comandos abaixo um por um.<\/p>\n
git add -A<\/code><\/pre>\n
git commit -m 'initial commit'<\/code><\/pre>\n
Melhore o padr\u00e3o de codifica\u00e7\u00e3o do Laravel usando GrumPHP<\/h3>\n
Assim que tivermos configurado o git em nosso projeto Laravel, estamos prontos para instalar a biblioteca GrumPHP. Para instal\u00e1-lo, execute o comando abaixo:<\/p>\n
composer require --dev phpro\/grumphp<\/code><\/pre>\n
Assim que o pacote for instalado, voc\u00ea dever\u00e1 ver a mensagem abaixo no terminal:<\/p>\n
Aten\u00e7\u00e3o! GrumPHP est\u00e1 farejando seus commits!<\/p>\n
Isso significa que o pacote foi instalado com sucesso. Em seguida, abra o grumphp.yml<\/code>arquivo e adicione o c\u00f3digo abaixo nele.<\/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
No c\u00f3digo acima, a parte importante \u00e9 a linha standard: PSR2<\/code>. Aqui, estamos dizendo ao GrumPHP para verificar as conven\u00e7\u00f5es de codifica\u00e7\u00e3o do PSR2 em rela\u00e7\u00e3o aos arquivos que ser\u00e3o confirmados. Usamos PSR2 aqui porque o Laravel segue os padr\u00f5es de codifica\u00e7\u00e3o PSR2. Depois disso, o GrumPHP iria realizar sua tarefa e nos informar sobre o erro em um console se encontrado.<\/p>\n
Se voc\u00ea n\u00e3o instalou a biblioteca padr\u00e3o de codifica\u00e7\u00e3o, execute o comando abaixo para instal\u00e1-la:<\/p>\n
composer require \"squizlabs\/php_codesniffer=*\"<\/code><\/pre>\n
Esta biblioteca possui padr\u00f5es de codifica\u00e7\u00e3o PSR2 inclu\u00eddos em seu n\u00facleo. Ent\u00e3o, GrumPHP ir\u00e1 verificar seu c\u00f3digo Laravel contra o PSR2 e sugerir mudan\u00e7as se voc\u00ea n\u00e3o estiver seguindo os padr\u00f5es PSR2.<\/p>\n
Digamos que temos um ImageController.php<\/code>arquivo em nosso projeto e o seguinte trecho de c\u00f3digo nele.<\/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
Em seguida, tente confirmar o c\u00f3digo acima e voc\u00ea dever\u00e1 ver uma sa\u00edda semelhante a abaixo:<\/p>\n
Ele fornece o erro de codifica\u00e7\u00e3o em detalhes, juntamente com o n\u00famero da linha e a descri\u00e7\u00e3o. Voc\u00ea tamb\u00e9m pode notar a linha:<\/p>\n
PHPCBF PODE FIXAR AS 2 VIOLA\u00c7\u00d5ES DE SNIFF MARCADAS AUTOMATICAMENTE<\/p>\n
Como usar o comando PHPCBF<\/h3>\n
Ao executar um comando PHPCBF, podemos corrigir alguns erros automaticamente. V\u00e1 para o diret\u00f3rio ‘vendor \/ bin’ do terminal e execute o comando abaixo para corrigir os erros usando PHPCBF.<\/p>\n
PHPCBF --standard=PSR2 PATH_TO_YOUR_CONTROLLER<\/code><\/pre>\n
Substitua o marcador pelos valores reais. Provavelmente, se voc\u00ea estiver executando este comando no Git bash, obter\u00e1 o erro ‘bash: phpcbf: command not found’. Nesse caso, execute este comando no prompt de comando do Windows. Em nosso caso, vemos a seguinte sa\u00edda no terminal.<\/p>\n
Observe que nem todos os erros s\u00e3o resolvidos por PHPCBH. \u00c0s vezes, voc\u00ea tamb\u00e9m precisa resolver o erro manualmente. Agora, quando voc\u00ea tenta confirmar o c\u00f3digo, deve obter a mensagem de sucesso e o c\u00f3digo tamb\u00e9m \u00e9 confirmado.<\/p>\n
Pensamentos finais<\/h3>\n
Neste tutorial, discutimos como melhorar os padr\u00f5es de codifica\u00e7\u00e3o do Laravel usando o GrumPHP. Mas n\u00e3o se limita apenas ao Laravel. Voc\u00ea tamb\u00e9m pode usar esta biblioteca em seus outros CMS, Frameworks. Estamos usando a biblioteca GrumPHP para nossos projetos Laravel, WordPress e PHP. Isso realmente nos ajuda a manter nosso estilo de codifica\u00e7\u00e3o de forma consistente.<\/p>\n
Artigos relacionados<\/h4>\n