Airbnb stila rokasgrāmata ir vadlīniju kopums tīra un konsekventa koda rakstīšanai. Tas tika izlaists 2012. gadā un kopš tā laika ir kļuvis par vienu no populārākajiem JavaScript projektu stila ceļvežiem.
Tas nodrošina vadlīniju kopumu konsekventa koda rakstīšanai, kuru ir viegli uzturēt, ieviešot dažādus stilus noteikumi par atkāpēm, komentāriem, maksimālo rindas garumu, mainīgo nosaukumu piešķiršanas konvencijām, pēdiņām un funkciju definīcijām. Lai JavaScript projektā iestatītu Airbnb stila rokasgrāmatu, jums ir jāizmanto tāds rīks kā ESLint.
Instalējiet ESLint
ESLint ir atvērtā koda JavaScript savākšanas rīks kas palīdz izstrādātājiem rakstīt tīru kodu, atrodot un novēršot problēmas. Tas var atklāt problēmas jūsu kodā, piemēram, sintakses kļūdas, nederīgus parametrus un nedefinētus mainīgos. Palaižot ESLint ar - - salabot tagu, tas automātiski identificē un novērš visas koda labojamās problēmas, tādējādi ietaupot jūsu laiku.
Varat izmantot ESLint, lai ieviestu stila rokasgrāmatas, piemēram, Airbnb stila rokasgrāmatas.
Lai sāktu, terminālī palaidiet šādu komandu, lai instalētu ESLint kā izstrādātāja atkarību:
npm install --save-dev eslint eslint-config-airbnb
Pēc tam inicializējiet ESLint.
npx eslint --init
Jums tiks uzdots jautājums par jūsu projektu. Kad tiek prasīts ar:
? Kā jūs vēlētos izmantot EsLint?
Izvēlieties šo opciju:
> Lai pārbaudītu sintaksi, atrodiet problēmas un ieviesiet koda stilu
Atbildiet uz nākamajiem jautājumiem atbilstoši savam projektam, līdz jūs saskaraties ar šādu uzvedni.
? Kā jūs vēlētos definēt sava projekta stilu?
Pēc tam atbildiet šādi.
> Izmantojiet populāru stila rokasgrāmatu
Nākamajai uzvednei atlasiet Airbnb stila rokasgrāmatu.
? Kuram stila ceļvedim vēlaties sekot?
> Airbnb:
Visbeidzot, instalējiet vajadzīgās atkarības, nākamajā uzvednē atlasot “Jā”.
Kad instalēšana ir pabeigta, jums vajadzētu būt a .eslintsrc.json failu savas mapes saknē.
Airbnb stila rokasgrāmatas pielāgošana
Airbnb stila rokasgrāmata ļauj pielāgot. Varat pievienot papildu noteikumus vai ignorēt esošās kārtulas .eslintsrc.json konfigurācijas fails.
Piemēram, lai atļautu ne vairāk kā 80 rakstzīmes katrā rindiņā, varat pievienot šo kārtulu noteikumu sadaļā.
{
"pagarina": [
"spraudnis: reaģēt/ieteicams",
"airbnb"
],
"noteikumi": {
"max-len": ["kļūda", { "kods": 80 }]
}
}Palaiž ESLint failā package.json
Pievienojiet skriptu pack.json failu, lai palaistu ESLint.
"skripti": {
"plūksna": "eslint"
}
Palaidiet lint skriptu, lai pārbaudītu, vai nav kļūdu, izpildot šo komandu.
npm palaist lint
Varat arī pievienot skriptu, lai novērstu koda problēmas, izmantojot -- labot karogs.
"skripti": {
"plūksna": "eslint",
"plūksna: labot": "npm palaist lint -- --labot"
},
Skriešana npm palaist savārstījums: labot terminālī automātiski novērsīs visas problēmas, kuras var novērst.
Iespējot Linting, izmantojot Save in VS Code
Skripta palaišana katru reizi, kad vēlaties izvilkt kodu, var būt apnicīgi. Izpildiet tālāk norādītās darbības, lai iespējotu uzlikšanu, saglabājot VS kodā.
- Atveriet cilni "Paplašinājumi" VS koda loga kreisajā pusē.
- Meklēt ESLint paplašinājums un instalējiet to.
- Kad paplašinājums ir instalēts, atveriet VS koda iestatījumus (Fails > Preferences > Iestatījumi vai nospiežot taustiņu kombināciju Ctrl +,).
- Iestatījumu redaktorā meklējiet "koda darbības saglabāšanas laikā".
- Noklikšķiniet uz Rediģēt sadaļā settings.json un pievienojiet tālāk norādītos iestatījumus settings.json failu.
{
"editor.codeActionsOnSave": {
"source.fixAll.eslint": taisnība
},
"eslint.validate": ["javascript"],
"eslint.run": "onSave",
}
Tas ļauj ESLint paplašinājumam automātiski salabot kodu, kad to saglabājat.
Stila rokasgrāmatas izmantošanas priekšrocības
Galvenā stila rokasgrāmatas, piemēram, Airbnb stila rokasgrāmatas, izmantošanas priekšrocība ir tā, ka tā palīdz uzturēt konsekventu kodu bāzi. Tas ir noderīgi komandā, jo izstrādātāji var viegli saprast koda bāzi un dot ieguldījumu tajā. Tas arī palīdz īstenot labāko praksi un izvairīties no izplatītām kodēšanas kļūdām.