Styl kódu Total.js: názvy, soubory, CSS, SQL a komponenty

Projekty Total.js sdílejí jeden styl a to je jejich síla: otevřete kterýkoli a víte, kde co je a jak je napsáno. Tato stránka shromažďuje na jednom místě konvence z Total.js guidelines (prověřená revize je zaznamenána v ai-sources.json). Nejprve se řiďte stylem projektu, ve kterém pracujete; toto jsou výchozí pravidla pro nový kód. Pro stranu frameworku si přečtěte konvence Total.js 5 pro asistenty při kódování.

JavaScript

• Soubory: malá písmena, s pomlčkami místo podtržítek (user-profile.js).
• Formát: tabulátory (šířka 4), žádné zbytečné mezery a středník na konci každého příkazu.
• Řetězce: jednoduché uvozovky pro krátké řetězce.
• Proměnné: v metodách používejte var nebo let a const si nechte pro začátek modulu.
• Cykly: kde se hodí, dává se přednost klasickému for před forEach().
• Závislosti: držte je na minimu a řiďte se kódem, který už tam je.

Názvy, které putují mezi projekty

Používejte všude stejný název pro stejnou věc, aby se kód dal přenášet mezi projekty a číst na první pohled:

Název	Použití
id, name, value, email	obvyklý identifikátor, jméno, hodnota a e-mail
items or arr, item	seznam a jeden jeho prvek
tmp	dočasná hodnota
dtcreated, dtupdated	data vytvoření a aktualizace

Schémata mají název v množném čísle začínající velkým písmenem (Contacts) a identifikátory se vytvářejí přes UID().

Použití require()

Na začátku modulu použijte const a název proměnné začněte velkým písmenem: const Fs = require('fs');.

CSS

• Názvy souborů malými písmeny s pomlčkami.
• Každé pravidlo stylu pište na jeden řádek.
• Předpony prohlížečů nepište ručně: přidejte komentář /*auto*/ a Total.js předpony doplní za vás.
• Jednoduché uvozovky a obyčejné CSS místo LESS nebo SASS.

Pluginy a komponenty (jComponent)

• Malá písmena pro názvy pluginů, komponent a položek FUNC., MAIN. a REPO. i pro proměnné.
• Podtržítkům se vyhýbejte, kde to jde, a vnoření držte na dvou či třech úrovních.
• Plugin se píše přes exports.; komponenta používá self, config a cls.
• Navrhujte pro opakované použití.

Skripty SQL

• Názvy tabulek a polí malými písmeny, tabulátory pro odsazení a středník na konci každého příkazu.
• Odstraňte zbytečná přetypování, skript naformátujte a tabulky, pohledy, procedury nebo funkce a indexy držte v samostatných skriptech.

Předpona	Pro
tbl_	tabulky, s názvem v jednotném čísle
cl_	číselníky
view_	pohledy
sp_	uložené procedury
fn_	funkce

V polích dt začíná datum, is začíná logickou hodnotu, klíče mají tvar id nebo userid a místo varchar se používá text. Kde se hodí, použijte id, name a dtcreated a sloupce seřaďte jako identifikátory, hlavní pole, čísla, logické hodnoty a data, s omezeními cizích klíčů na konci.

Složky

Obrázky dávejte do /img/, skripty do /js/, styly do /css/, písma do /fonts/ a videa do /videos/ a soubory pojmenovávejte s pomlčkami.

Proč to pomáhá

Společný styl usnadňuje předání, kontrolu a rozšiřování projektu a dává AI asistentovi jasný vzor. Dejte svému asistentovi tuto stránku spolu s konvence Total.js 5 pro asistenty při kódování a jeho kód zapadne do zbytku vaší aplikace.