Code-Style
Sprache im Code
Section titled “Sprache im Code”- Fachbegriffe auf Deutsch: Module, Entities und DTOs nutzen deutsche
Domänenbegriffe —
beitrag,betreuungsvertraege,elternportal,tagespflege,fremdgemeinde,sachkostenzuschuss,vermittlung,zuschussusw. - Technische Begriffe auf Englisch:
auth,tenant,user,mail,supportund alle technischen Konstrukte bleiben englisch. - Code-Kommentare auf Englisch.
Datei-Header
Section titled “Datei-Header”Jede Source-Datei beginnt mit dem Property-Header:
// Property of Ralf Carsjens - created in order to fulfill ISO 27001Ausnahmen: Standard-JSON-Dateien, generierte Dateien und Lockfiles.
TypeScript-Regeln
Section titled “TypeScript-Regeln”strict: trueist verbindlich.- Kein
anyohne Begründung — stattdessenunknownplus Type-Guard. - Kein
@ts-ignore— bei Bedarf@ts-expect-errormit Begründung. consistent-type-importsist aktiviert.
Allgemeine Prinzipien
Section titled “Allgemeine Prinzipien”- Struktur vor Schnelligkeit: modularer, gut kommentierter Code statt Quick-and-Dirty-Lösungen.
- Kompakt schreiben: doppelte Branches zusammenführen, unnötige Verschachtelung vermeiden, gemeinsame Abstraktionen nutzen.
- Bestehende Konventionen beachten: vor dem Schreiben neuer Komponenten zunächst prüfen, wie vergleichbare Komponenten im Codebase aufgebaut sind.
