A Total.js kódstílusa: nevek, fájlok, CSS, SQL és komponensek

A Total.js projektek egyetlen stílust osztanak, és ez erősség: bármelyiket megnyitod, tudod, hol mi van és hogyan van megírva. Ez az oldal egy helyen gyűjti össze a Total.js guidelines konvencióit (a vizsgált revíziót a ai-sources.json rögzíti). Először annak a projektnek a stílusát kövesd, amelyen dolgozol; ezek az új kód alapértelmezett szabályai. A keretrendszer oldaláról olvasd el a következőt: Total.js 5 konvenciók kódoló asszisztenseknek.

JavaScript

• Fájlok: kisbetűs nevek, aláhúzás helyett kötőjellel (user-profile.js).
• Elrendezés: tabulátorok (szélesség 4), felesleges szóközök nélkül, és pontosvessző minden utasítás végén.
• Karakterláncok: egyszeres idézőjel a rövid karakterláncokhoz.
• Változók: a metódusokban var vagy let használj, a const-ot pedig tartsd a modul tetejére.
• Ciklusok: ahol illik, a klasszikus for előnyben van a forEach() helyett.
• Függőségek: tartsd minimálisan, és kövesd a már meglévő kódot.

Projektek között utazó nevek

Mindenhol ugyanazt a nevet használd ugyanarra, hogy a kód projektek között mozgatható és egy pillantásra olvasható legyen:

Név	Használat
id, name, value, email	a szokásos azonosító, név, érték és e-mail
items or arr, item	egy lista és az egyik eleme
tmp	egy ideiglenes érték
dtcreated, dtupdated	létrehozás és frissítés dátuma

A sémák többes számú, nagybetűvel kezdődő nevet kapnak (Contacts), az azonosítókat pedig a UID() hozza létre.

A require() használata

A modul tetején használj const-ot, és a változó nevét nagybetűvel kezdd: const Fs = require('fs');.

CSS

• Kisbetűs fájlnevek kötőjellel.
• Minden stílusszabályt egyetlen sorba írj.
• A böngészőelőtagokat ne kézzel írd: add hozzá a /*auto*/ megjegyzést, és a Total.js ellátja a szabályokat előtaggal.
• Egyszeres idézőjel, és sima CSS a LESS vagy SASS helyett.

Bővítmények és komponensek (jComponent)

• Kisbetűs nevek a bővítményeknek, komponenseknek és a FUNC., MAIN. és REPO. bejegyzéseinek, valamint a változóknak.
• Kerüld az aláhúzást, ahol tudod, és tartsd a beágyazást két-három szinten.
• A bővítményt exports. használatával írják; a komponens a self, config és cls elemeket használja.
• Tervezz újrahasznosításra.

SQL-szkriptek

• Kisbetűs tábla- és mezőnevek, tabulátorok a behúzáshoz és pontosvessző minden utasítás végén.
• Távolítsd el a felesleges típuskonverziókat, formázd a szkriptet, és a táblákat, nézeteket, eljárásokat vagy függvényeket és indexeket külön szkriptekben tartsd.

Előtag	Mihez
tbl_	táblák, egyes számú névvel
cl_	kódlisták
view_	nézetek
sp_	tárolt eljárások
fn_	függvények

A mezőkben a dt dátumot, az is logikai értéket kezd, a kulcsok az id vagy userid mintát követik, a varchar helyett pedig text használatos. Használd az id, name és dtcreated mezőket, ahol illenek, és az oszlopokat így rendezd: azonosítók, fő mezők, számok, logikai értékek és dátumok, az idegenkulcs-megszorításokkal a végén.

Mappák

A képeket tedd az /img/, a szkripteket a /js/, a stílusokat a /css/, a betűtípusokat a /fonts/, a videókat pedig a /videos/ mappába, a fájlokat pedig kötőjellel nevezd el.

Miért segít

A közös stílus megkönnyíti a projekt átadását, átnézését és bővítését, és egyértelmű mintát ad az MI-asszisztensnek. Add az asszisztensednek ezt az oldalt a következővel együtt: Total.js 5 konvenciók kódoló asszisztenseknek, és a kódja illeszkedni fog az alkalmazásod többi részéhez.