Eigene Regeln sind das was CodeCharter vom statischen Checker zum Team-Tool macht. Wo ihr anfangt hängt davon ab, wie tief ihr schon im Thema seid.
Erstes Mal eine eigene Regel schreiben
Erste eigene Regel im Quick-Start
führt euch durch den kompletten Workflow: Datei anlegen, validieren,
in ./.codecharter/rules/ legen, laufen lassen.
Die DSL kennenlernen
Hello-World-DSL ist die kleinstmögliche
sinnvolle Regel, Zeile für Zeile erklärt. Danach lohnt sich
Datei-Struktur für das
.codecharter-Verzeichnis und Syntax-Übersicht
als kompakte Sprach-Referenz.
Tiefer einsteigen
Wenn ihr schon mit der DSL vertraut seid, sind die nächsten drei Seiten interessant:
- DSL-Grammatik: formale EBNF-Referenz, wenn ihr genau wissen wollt was der Parser akzeptiert.
- Prädikat-Katalog: vollständige Liste aller Properties pro Code-Modell-Entität.
- Regel-Beispiele: Galerie fertig komponierter Regeln, nach Use-Case sortiert.
Konventionen für gute Regeln
Best Practices sammelt was wir uns selbst beim Schreiben unserer mitgelieferten Regeln zur Faustregel gemacht haben.