{"id":24143,"date":"2021-05-12T09:24:00","date_gmt":"2021-05-12T06:24:00","guid":{"rendered":"https:\/\/themewp.inform.click\/?p=24143"},"modified":"2021-10-18T02:19:23","modified_gmt":"2021-10-17T23:19:23","slug":"ameliorez-vos-normes-de-codage-laravel-en-utilisant-grumphp","status":"publish","type":"post","link":"https:\/\/themewp.inform.click\/fr\/ameliorez-vos-normes-de-codage-laravel-en-utilisant-grumphp\/","title":{"rendered":"Am\u00e9liorez vos normes de codage Laravel en utilisant GrumPHP"},"content":{"rendered":"

Que vous soyez un d\u00e9veloppeur exp\u00e9riment\u00e9 ou novice, vous devez am\u00e9liorer vos normes de codage pour devenir un meilleur d\u00e9veloppeur. Que vous travailliez seul ou en \u00e9quipe, il est toujours recommand\u00e9 d’avoir les m\u00eames conventions de codage tout au long du projet. Mais maintenir les m\u00eames normes partout n’est pas facile si nous le v\u00e9rifions manuellement. Il peut arriver que vous ayez manqu\u00e9 la norme m\u00eame si vous avez d\u00e9cid\u00e9 de la suivre. C’est une erreur humaine, on a rat\u00e9 parfois des choses qu’il ne fallait pas. Pour \u00e9viter de tels probl\u00e8mes, nous devons automatiser notre flux de travail. Ce faisant, notre syst\u00e8me automatis\u00e9 s’occupera de la t\u00e2che que nous lui avons assign\u00e9e et 99,99% du temps, il n’\u00e9choue jamais.<\/p>\n

GrumPHP<\/a> est une biblioth\u00e8que qui garde un \u0153il sur chaque commit git. Si votre code ne respecte pas les normes donn\u00e9es, la biblioth\u00e8que ne vous permet pas de valider le code. Vous devez d’abord corriger votre code, puis vous seul pouvez vous engager dans Git.<\/p>\n

\u00c7a a l’air bien? Voyons-le en action.<\/p>\n

Commencer<\/h3>\n

Comme nous parlons des normes de codage Laravel, vous devriez avoir une configuration de projet Laravel. Si vous ne l’avez pas, installez-le par la commande\u00a0:<\/p>\n

composer create-project --prefer-dist laravel\/laravel laravel-dev<\/code><\/pre>\n
Ici ‘laravel-dev’ est le nom de votre projet. Ouvrez le terminal dans le r\u00e9pertoire racine de votre projet et initialisez le fichier git.<\/p>\n
git init<\/code><\/pre>\n
Il est obligatoire d’avoir Git dans votre projet afin de profiter de GrumPHP. C’est l\u00e0 que \u00e7a marche. Lorsque nous installons GrumPHP, il cr\u00e9e un hook dans le .git<\/code>dossier, puis surveille chaque commit.<\/p>\n
Maintenant, ajoutez et validez vos fichiers actuels dans le git en utilisant les commandes ci-dessous une par une.<\/p>\n
git add -A<\/code><\/pre>\n
git commit -m 'initial commit'<\/code><\/pre>\n
Am\u00e9liorer la norme de codage Laravel \u00e0 l’aide de GrumPHP<\/h3>\n
Une fois que nous avons configur\u00e9 git dans notre projet Laravel, nous sommes pr\u00eats \u00e0 installer la biblioth\u00e8que GrumPHP. Pour l’installer, ex\u00e9cutez la commande ci-dessous\u00a0:<\/p>\n
composer require --dev phpro\/grumphp<\/code><\/pre>\n
Une fois le package install\u00e9, vous devriez voir le message ci-dessous dans le terminal\u00a0:<\/p>\n
Attention! GrumPHP renifle vos commits !<\/p>\n
Cela signifie que le paquet est install\u00e9 avec succ\u00e8s. Ensuite, ouvrez le grumphp.yml<\/code>fichier et ajoutez-y le code ci-dessous.<\/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
Dans le code ci-dessus, la partie importante est la ligne standard: PSR2<\/code>. Ici, nous disons \u00e0 GrumPHP de v\u00e9rifier les conventions de codage PSR2 par rapport aux fichiers qui vont \u00eatre valid\u00e9s. Nous avons utilis\u00e9 PSR2 ici car Laravel suit les normes de codage PSR2. Apr\u00e8s cela, GrumPHP effectuerait sa t\u00e2che et nous informerait de l’erreur dans une console si elle \u00e9tait trouv\u00e9e.<\/p>\n
Si vous n’avez pas install\u00e9 la biblioth\u00e8que standard de codage, ex\u00e9cutez la commande ci-dessous pour l’installer\u00a0:<\/p>\n
composer require \"squizlabs\/php_codesniffer=*\"<\/code><\/pre>\n
Cette biblioth\u00e8que a des normes de codage PSR2 incluses dans son noyau. Ainsi, GrumPHP v\u00e9rifiera votre code Laravel par rapport au PSR2 et vous sugg\u00e9rera des modifications si vous ne suivez pas les normes PSR2.<\/p>\n
Disons que nous avons un ImageController.php<\/code>fichier dans notre projet et que le morceau de code suivant s’y trouve.<\/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
Ensuite, essayez de valider le code ci-dessus et vous devriez voir une sortie comme ci-dessous\u00a0:<\/p>\n
Il donne l’erreur de codage en d\u00e9tail avec le num\u00e9ro de ligne et la description. Vous pouvez \u00e9galement remarquer la ligne\u00a0:<\/p>\n
PHPCBF PEUT CORRIGER AUTOMATIQUEMENT LES 2 VIOLATIONS SNIFF MARQU\u00c9ES<\/p>\n
Comment utiliser la commande PHPCBF<\/h3>\n
En ex\u00e9cutant une commande PHPCBF, nous pouvons corriger certaines erreurs automatiquement. Rendez-vous dans le r\u00e9pertoire ‘vendor\/bin’ du terminal et ex\u00e9cutez la commande ci-dessous pour corriger les erreurs \u00e0 l’aide de PHPCBF.<\/p>\n
PHPCBF --standard=PSR2 PATH_TO_YOUR_CONTROLLER<\/code><\/pre>\n
Remplacez l’espace r\u00e9serv\u00e9 par les valeurs r\u00e9elles. Si vous ex\u00e9cutez cette commande dans Git bash, vous obtiendrez probablement l’erreur "bash: phpcbf: command not found". Dans ce cas, ex\u00e9cutez cette commande dans l’invite de commande Windows. Dans notre cas, nous voyons la sortie suivante sur le terminal.<\/p>\n
Notez que toutes les erreurs ne sont pas r\u00e9solues par PHPCBH. Parfois, vous devez \u00e9galement r\u00e9soudre l’erreur manuellement. Maintenant, lorsque vous essayez de valider le code, vous devriez obtenir le message de r\u00e9ussite et le code est \u00e9galement valid\u00e9.<\/p>\n
Derni\u00e8res pens\u00e9es<\/h3>\n
Dans ce tutoriel, nous avons discut\u00e9 de l’am\u00e9lioration des normes de codage Laravel \u00e0 l’aide de GrumPHP. Mais ce n’est pas limit\u00e9 \u00e0 Laravel seulement. Vous pouvez \u00e9galement utiliser cette biblioth\u00e8que dans vos autres CMS, Frameworks. Nous utilisons la biblioth\u00e8que GrumPHP pour nos projets Laravel, WordPress et PHP de base. Cela nous aide vraiment \u00e0 maintenir notre style de codage de mani\u00e8re coh\u00e9rente.<\/p>\n
Articles Li\u00e9s<\/h4>\n