Parandage oma Laraveli kodeerimisstandardeid GrumPHP abil
Ükskõik, kas olete kogenud arendaja või värskem, peaksite paremaks arendajaks muutmiseks parandama oma kodeerimisstandardeid. Kas töötate üksi või meeskonnaga, on alati hea tava, et kogu projekti vältel on samad kodeerimiskonventsioonid. Kuid kõigis kohtades samade standardite säilitamine pole lihtne, kui kontrollime seda käsitsi. Võib juhtuda, et lasite standardist mööda, isegi kui otsustate seda järgida. See on inimlik viga, me jätsime vahel tegemata asjadest, mida me ei peaks. Selliste probleemide vältimiseks peaksime oma töövoo automatiseerima. Seda tehes hoolitseb meie automatiseeritud süsteem talle määratud ülesande eest ja 99,99% ajast see kunagi ei õnnestu.
GrumPHP on raamatukogu, mis hoiab silma peal teie iga giti pühendumisel. Kui teie kood ei järgi antud standardeid, ei luba teek teil koodi siduda. Kõigepealt peaksite oma koodi parandama ja seejärel saate ainult Gitile pühenduda.
Kõlab hästi? Vaatame seda tegevuses.
Alustamine
Kuna me räägime Laraveli kodeerimisstandarditest, peaks teil olema Laraveli projekti häälestus. Kui teil seda pole, installige see käsuga:
composer create-project --prefer-dist laravel/laravel laravel-devSiin on ‘laravel-dev’ teie projekti nimi. Avage oma projekti juurkataloogis terminal ja lähtestage git.
git initGrumPHP kasutamiseks peab teie projektis olema Git. Siin see töötab. Kui installime GrumPHP, loob see .gitkausta sisemise konksu ja jälgib seejärel iga pühendumist.
Nüüd lisage oma praegused failid gitile, kasutades ükshaaval allolevaid käske.
git add -Agit commit -m 'initial commit'Parandage Laraveli kodeerimise standardit, kasutades GrumPHP-d
Kui oleme oma Laraveli projektis giti seadistanud, on hea minna GrumPHP teegi installima. Selle installimiseks käivitage järgmine käsk:
composer require --dev phpro/grumphpKui pakett on installitud, peaksite terminalis nägema allolevat teadet:
Vaata ette! GrumPHP nuusutab teie kohustusi!
See tähendab, et pakett on edukalt installitud. Järgmisena avage grumphp.ymlfail ja lisage sellesse allolev kood.
parameters:
git_dir:. bin_dir: vendor/bin
tasks: {
phpcs: {
standard: PSR2
}
}Ülaltoodud koodis on oluline osa rida standard: PSR2. Siinkohal ütleme GrumPHP-le, et nad kontrolliksid PSR2 kodeerimiskonventsioone failidega, mida kavatsetakse siduda. Kasutasime siin PSR2, kuna Laravel järgib PSR2 kodeerimisstandardeid. Pärast seda täidaks GrumPHP oma ülesande ja teavitaks meid veast konsoolis, kui see leitakse.
Kui te ei ole kodeerimise standardset teeki installinud, käivitage selle installimiseks järgmine käsk:
composer require "squizlabs/php_codesniffer=*"Selle raamatukogu tuum sisaldab PSR2 kodeerimisstandardeid. Niisiis, GrumPHP kontrollib teie Laraveli koodi PSR2 alusel ja soovitab teil muudatusi teha, kui te ei järgi PSR2 standardeid.
Oletame, et meil on ImageController.phpprojektis fail ja selles on järgmine koodijupp .
public function store(Request $request)
{
if($request->hasFile('profile_image')) {
//get filename with extension
$filenamewithextension = $request->file('profile_image')->getClientOriginalName();
//get filename without extension
$filename = pathinfo($filenamewithextension, PATHINFO_FILENAME);
//get file extension
$extension = $request->file('profile_image')->getClientOriginalExtension();
//filename to store
$filenametostore = $filename.'_'.time().'.'.$extension;
//Upload File
$request->file('profile_image')->storeAs('public/profile_images', $filenametostore);
if(!file_exists(public_path('storage/profile_images/crop'))) {
mkdir(public_path('storage/profile_images/crop'), 0755);
}
// crop image
$img = Image::make(public_path('storage/profile_images/'.$filenametostore));
$croppath = public_path('storage/profile_images/crop/'.$filenametostore);
$img->crop($request->input('w'), $request->input('h'), $request->input('x1'), $request->input('y1'));
$img->save($croppath);
// you can save crop image path below in database
$path = asset('storage/profile_images/crop/'.$filenametostore);
return redirect('image')->with(['success' => "Image cropped successfully.", 'path' => $path]);
}
}Järgmisena proovige siduda ülaltoodud kood ja peaksite nägema väljundit nagu allpool:
See annab üksikasjades kodeerimisvea koos rea numbri ja kirjeldusega. Võite märgata ka rida:
PHPCBF SAAB 2 MÄRGISTATUD SNIFF-RIKKUMIST AUTOMAATSELT PARANDADA
Kuidas kasutada PHPCBF-käsku
Käivitades PHPCBF-käsu, saame mõned vead automaatselt parandada. Minge terminalist kataloogi ‘vendor / bin’ ja käivitage PHPCBF-i abil vigade parandamiseks järgmine käsk.
PHPCBF --standard=PSR2 PATH_TO_YOUR_CONTROLLERAsendage kohatäide tegelike väärtustega. Tõenäoliselt, kui kasutate seda käsku Git bashis, kuvatakse tõrge "bash: phpcbf: käsk ei leitud". Sel juhul käivitage see käsk Windowsi käsuviibal. Meie puhul näeme terminalis järgmist väljundit.
Pange tähele, et kõiki vigu ei lahenda PHPCBH. Mõnikord peate ka vea käsitsi lahendama. Nüüd, kui proovite koodi kinnitada, peaksite saama eduteate ja kood ka siduma.
Lõpumõtted
Selles õpetuses oleme arutanud Laraveli kodeerimisstandardite täiustamist GrumPHP abil. Kuid see ei piirdu ainult Laraveliga. Seda teeki saate kasutada ka oma teises CMS-i raamistikus. Kasutame oma Laraveli, WordPressi ja PHP põhiprojektide jaoks GrumPHP teeki. See aitab meil tõesti oma kodeerimisstiili järjepidevalt säilitada.