====== Codequalität-Checkliste ======

Prüfungen für Namenskonventionen, Funktionsdesign, DRY-Prinzip und SSOT.

<note>Diese Checkliste ergänzt die [[.:code-konventionen|Code-Konventionen]] mit konkreten Prüfpunkten.</note>

===== Namenskonventionen =====

==== Namespace-Pattern (MS-Stil) ====

<code>
[ ] Unit-Namen folgen WvdS.<Kategorie>.<Komponente>.pas
[ ] Spiegelt Microsoft .NET Struktur mit WvdS. Präfix
[ ] Beispiel: WvdS.UI.Controls.Button, WvdS.System.Logging
</code>

==== Klassen-Hierarchie (Borland-Stil) ====

<code>
[ ] Abstrakte Basis verwendet TWvdSCustom* Präfix
[ ] Öffentliche Basis verwendet TWvdSBase* Präfix
[ ] Konkrete Klassen verwenden TWvdS* Präfix
[ ] Pattern: TWvdSCustomXxx → TWvdSBaseXxx → TUserXxx
</code>

==== Typ-Präfixe ====

^ Kategorie ^ Präfix ^ Beispiel ^
| Klassen | ''TWvdS*'' | ''TWvdSRouter'', ''TWvdSButton'' |
| Interfaces | ''IWvdS*'' | ''IWvdSActionResult'', ''IWvdSBindable'' |
| Exceptions | ''EWvdS*'' | ''EWvdSRoutingException'' |
| Records | ''TWvdS*'' | ''TWvdSBuildResult'' |
| Enums | ''TWvdS*'' | ''TWvdSProjectType'' |
| Callbacks | ''TWvdS*'' | ''TWvdSBuildCallback'' |

==== Allgemeine Benennung ====

<code>
[ ] Beschreibende Namen (keine Einzelbuchstaben außer Schleifen)
[ ] Keine Abkürzungen außer bekannte (URL, HTTP, JSON)
[ ] Interfaces haben GUID für DI-Container
[ ] Private Felder: F* Präfix (FValue, FCount)
[ ] Parameter: A* Präfix (AIndex, APath)
</code>

===== Funktionsdesign =====

==== Größen-Richtlinien ====

<code>
[ ] 12-24 Zeilen ideal
[ ] Maximum 40 Zeilen (darüber aufteilen)
[ ] Maximale Verschachtelungstiefe: 3
</code>

==== Parameter-Richtlinien ====

<code>
[ ] Maximum 5-7 Parameter
[ ] Bei mehr Parametern: Record/Klasse verwenden
[ ] Optionale Parameter am Ende
</code>

==== Single Responsibility ====

<code>
[ ] Jede Funktion hat EINE Aufgabe
[ ] Funktionsname beschreibt die Aufgabe vollständig
[ ] Wenn "und" im Namen nötig → aufteilen
</code>

==== Verb-First Naming ====

<code>
[ ] Get* - Wert abrufen
[ ] Set* - Wert setzen
[ ] Calculate* - Berechnung durchführen
[ ] Process* - Verarbeitung durchführen
[ ] Validate* - Validierung durchführen
[ ] Create* - Objekt erstellen
[ ] Parse* - Eingabe parsen
[ ] Format* - Ausgabe formatieren
</code>

===== DRY-Prinzip =====

<code>
[ ] Kein duplizierter Code (mehr als 3 identische Zeilen → extrahieren)
[ ] Keine Copy-Paste-Patterns
[ ] Gemeinsame Logik in Hilfsfunktionen
[ ] Konstanten statt wiederholter Literale
</code>

==== Beispiel: DRY-Verletzung beheben ====

<code pascal>
(* VERBOTEN - Duplizierter Code *)
procedure ProcessUserA(const AUser: TUser);
begin
  if not ValidateEmail(AUser.Email) then
    raise EValidationError.Create('Invalid email');
  if Length(AUser.Name) > 64 then
    raise EValidationError.Create('Name too long');
  (* ... weitere Verarbeitung *)
end;

procedure ProcessUserB(const AUser: TUser);
begin
  if not ValidateEmail(AUser.Email) then
    raise EValidationError.Create('Invalid email');
  if Length(AUser.Name) > 64 then
    raise EValidationError.Create('Name too long');
  (* ... andere Verarbeitung *)
end;

(* KORREKT - Gemeinsame Logik extrahiert *)
procedure ValidateUser(const AUser: TUser);
begin
  if not ValidateEmail(AUser.Email) then
    raise EValidationError.Create(rsInvalidEmail);
  if Length(AUser.Name) > MAX_NAME_LENGTH then
    raise EValidationError.Create(rsNameTooLong);
end;

procedure ProcessUserA(const AUser: TUser);
begin
  ValidateUser(AUser);
  (* ... weitere Verarbeitung *)
end;
</code>

===== SSOT-Prüfung =====

<note warning>**Single Source of Truth** - Keine lokalen Kopien von Common-Code!</note>

==== Common Libraries verwenden ====

<code>
[ ] NodeJS-APIs via ~/sources/common/web/nodejs/
    - NodeJS.FS, NodeJS.Path, NodeJS.ChildProcess
[ ] VSCode-APIs via ~/sources/common/web/vscode/
    - VSCode.Window, VSCode.Commands, VSCode.Workspace
[ ] WvdS Core via ~/sources/common/core/
    - WvdS.System.Logging, WvdS.VSCode.Security
</code>

==== Verboten ====

<code>
[ ] Keine direkten require()-Aufrufe in Extensions
[ ] Keine Duplikate von Common-Units in Extensions
[ ] Keine lokalen Wrapper-Implementierungen
</code>

==== Beispiel: SSOT-Verletzung ====

<code pascal>
(* VERBOTEN - Lokaler require() *)
function FileExists(const APath: string): Boolean;
begin
  asm
    var fs = require('fs');  (* SSOT-Verletzung! *)
    Result = fs.existsSync(APath);
  end;
end;

(* KORREKT - Common Library *)
uses
  NodeJS.FS;

function FileExists(const APath: string): Boolean;
begin
  Result := ExistsSync(APath);  (* Aus NodeJS.FS *)
end;
</code>

===== Separation of Concerns =====

<code>
[ ] UI-Logik nur in UI-Schicht (extension_main, *Dialog)
[ ] Geschäftslogik nur in Service-Schicht (*Service)
[ ] Datenstrukturen nur in Model-Schicht (*Models)
[ ] Services rufen keine VSCode-APIs direkt auf
[ ] Models enthalten keine Logik
</code>

==== Schichten-Architektur ====

<code>
┌─────────────────────────────────────────────────┐
│  UI Layer (extension_main.pas, *Dialog.pas)    │
│  → VSCode APIs, User Interaction               │
├─────────────────────────────────────────────────┤
│  Service Layer (*Service.pas)                  │
│  → Geschäftslogik, Validierung                 │
├─────────────────────────────────────────────────┤
│  Model Layer (*Models.pas)                     │
│  → Records, Typen, Enums                       │
├─────────────────────────────────────────────────┤
│  Infrastructure (NodeJS.*, VSCode.*, WvdS.*)   │
│  → Externe APIs, Platform-Abstraktion          │
└─────────────────────────────────────────────────┘
</code>

===== Schnell-Checkliste zum Kopieren =====

<code>
Review-Checkliste (Code-Qualität):

Naming:
- [ ] Unit-Namen: WvdS.<Kategorie>.<Komponente>.pas
- [ ] Klassen: TWvdS* Präfix
- [ ] Interfaces: IWvdS* Präfix
- [ ] Beschreibende Namen (keine Abkürzungen)

Funktionen:
- [ ] 12-24 Zeilen ideal, max 40
- [ ] Max 5-7 Parameter
- [ ] Single Responsibility
- [ ] Verb-First Naming

DRY:
- [ ] Kein duplizierter Code
- [ ] Gemeinsame Logik extrahiert
- [ ] Konstanten statt Literale

SSOT:
- [ ] Common Libraries verwendet
- [ ] Keine lokalen require()-Aufrufe
- [ ] Keine Duplikate von Common-Units

SoC:
- [ ] UI nur in UI-Schicht
- [ ] Logik nur in Service-Schicht
- [ ] Services ohne direkte VSCode-Aufrufe
</code>

===== Siehe auch =====

  * [[.:qualitaetssicherung|Qualitätssicherung Übersicht]]
  * [[.:code-konventionen|Code-Konventionen]]
  * [[.:audit-core|Core-Checkliste]]
  * [[.:extension-entwicklung|Extension-Entwicklung]]