dbwebb-se / databas

Course repo for database course (dbw).
Other
4 stars 2 forks source link

Kodvalidering för JavaScript och SQL #45

Open mosbth opened 2 years ago

mosbth commented 2 years ago

I kursen gäller för tillfället följande om statisk kodvalidering.

Det är främst eslint som gäller för JS-koden. https://github.com/dbwebb-se/databas/blob/master/.eslintrc.json

Står en not om det i kmom02. https://dbwebb.se/kurser/databas-v2/kmom02#artiklar

När det gäller kodstandard för SQL så har vi (ännu) ingen validator men rekommendationen nämns under kmom01: https://dbwebb.se/kurser/databas-v2/kmom01#artiklar

Jag hade gärna försökt finna en SQL validator men jag har inte riktigt letat tillräckligt.

Det som jag nu mest funderar på är att ändra hur vi gör valideringen av JS kod och "lätta upp" så att studenten själv kan anpassa sin kodstil. Det innebär att jag delvis måste lämna dbwebb validate för js-valieringen och implementera den förslagsvis i package.json.

Det finns fördelar med det (eget aktivt val om kodstil, lära sig hur man konfigurerar sin miljö, möjlighet att använda:fix för att laga kodstilen, enklare att följa uppgraderingar, enklare byta till ES moduler) men det är en del arbete som påverkar kursrepot så det arbetet måste ske när kursen inte är aktiv.

Jag lutar för tillfället mest åt att köra kodstilen JavaScript Standard och ge vår klassiska dbwebb-stil som ett alternativ.

De validatorer jag tänker använda är (initialt)

Dbwebb-stilen kom fram på den tiden då jag ville ha en mer gemensam kodstil för PHP och JavaScript. Men numer känner jag personligen att kodstil kan skifta mellan kurser och projekt, så länge det finns validatorer och man kan göra :fix med dem så är kodstilen underordnad så länge test och validering passerar. Jag har numer inga problem att blanda kodstilar i utbildningen, jag ser tom att det är en fördel att göra det - så länge man kör sina validatorer.

Ni får gärna ge förslag och berätta hur ni skulle vilja se det och om det finns särskilda önskemål som eventuellt kan tillgodoses.

mosbth commented 2 years ago

I katalogen example/ lade jag till ett test för lokal utvecklingsmijlö med eslint och dess fixer. Se här: https://github.com/dbwebb-se/databas/blob/master/example/README.md

Där finns också instruktioner hur man kan lägga in den under me/ och få tillgång till eslint och eslint --fix.