3.1 KiB
Razvojne konvencije Terminološkega portala
Tale dokument se bo dopolnjeval in ga v končnem repozitoriju ne bo ali pa bo v končni obliki v angleščini.
Priporočen editor, nastavitve in razširitve
-
Visual Studio Code ima za razvoj Node.js aplikacij ogromno uporabnih funkcionalnosti že vgrajenih
-
Nastavitve in razširitve niso vključene v Git repozitorij, vendar jih Luka z veseljem priporoči/deli. Še posebej je uporabna launch konfiguracija za debugiranje kode v kontejnerju v realnem času.
-
V VS Codu se da ta dokument brati v formatirani obliki z zagonom (Ctrl + Shift + P) ukaza
Markdown: Open Preview
Git workflow
-
Commit messagi naj spoštujejo to konvencijo in naj bodo v angleščini.
-
Za začetek ne commitajmo direktno v master vejo. Vsakršno delo naj bo opravljeno na ločeni veji, ki pa jo bo Luka po potrebi dopolnil/prilagodil in dodal v master. Tipičen tok naj torej sledi naslednjemu vzorcu:
- Posodobiš master na najnovejšo verzijo:
git pull origin master - Narediš novo vejo za dopolnitve:
git checkout -b <ime veje>- Ime veje naj bo formata <ime>/<dopolnitev>
- Primer imena veje: jure/admin-console
- Narediš potrebne popravke v kodi in jih poljubnokrat, toda vsaj enkrat, commitaš:
git commit -m "<Commit message>" - Vejo porineš na remote repositorij:
git push origin <ime veje> - Luku sporočiš, da je veja končana in pripravljena za integracijo v master
- Ko Luka sporoči, da je bila veja integrirana, jo izbrišeš lokalno in na remote repozitoriju
- Greš na master:
git checkout master - Lokalni izbris:
git branch -D <ime veje> - Remote izbris:
git push origin --delete <ime veje>
- Greš na master:
- Posodobiš master na najnovejšo verzijo:
Sintaksa
Splošno
- Za večino znanih tipov datotek za enotno formatiranje skrbi kombinacija ESLint-a in Prettier-ja. Kljub temu je spodaj navedenih nekaj splošnih smernic, ki jih upoštevajmo na splošno, v vseh datotekah.
- Za integracijo zgoraj navedenih orodij v VS Code in poenastavitev workflowa vam lahko pomaga Luka
- Če ne uporabljate integracije teh orodij v text editor, pred vsakim git commitom poženite
npm run format - Če se bo v git repozitorij začela objavljati neformatirana koda, bomo morali uporabiti git hooke; najraje na klientovi strani, sicer na strežniški
Splošne smernice
- Zamik enega nivoja naj bo povsod 2 presledka (JS, CSS, Pug, ...)
- Datoteke naj se končajo z newlinom.
- Komentarji se povedi. Začnejo se z veliko začetnico in končajo z ločilom.
JS
- smernice in oblikovanje temeljijo na JavaScript Standard Stilu z dodatnimi dopolnitvami
- uporaba console metod (log, warn, error, ...) v končni kodi ni dovoljena
- ker je končnemu uporabniku (na klientovi strani) neuporabna in lahko kvečjemu razkrije neželene detajle
- ker je sinhrona in zato neprimerna za strežniško stran (Node)
- za debugiranje lahko uporabljamo debug modul ali log pointe debuggerskega orodja. V skrajnem primeru lahko uporabite console metode, a jih pred git commitom odstranite