Generierungsvariablen

Ein Template kennt Ihr Projekt nicht. Die Generierungsvariablen sind die Brücke: das Template deklariert die Variablen, die es benötigt, und Sie füllen ihren Wert aus in Restorm. Bei der Generierung wird jeder Wert ausgewertet und dann in den Kontext des Templates injiziert.

Variable oder natives Flag?

Verwenden Sie eine Variable nur für das, was das Design nicht bereits trägt. Die Absichten, die Sie im Design erfasst haben (searchable, PII, Volumen, Zugriffsprofil, Traffic, Aktualität, Sensibilität, Aufbewahrung, Cache, Authentifizierung…), sind im Template über ctx direkt lesbar — es ist unnötig, sie erneut zu deklarieren. Siehe Der Kontext des Templates. Die Variablen dienen den template-eigenen Einstellungen: Paketname, Namespace, Framework-Version, ein Dockerfile generieren oder nicht usw.

Deklarieren und ausfüllen

Jede Variable wird vom Template deklariert (in seiner restorm-template.json) mit einem Namen, einem Geltungsbereich, einem Typ, einem Standardwert und einer optionalen Beschreibung. Auf der Restorm-Seite füllen Sie ihren Wert in Form eines Handlebars-Ausdrucks aus — für jede betroffene Entität ausgewertet und dann in den deklarierten Typ konvertiert.

Die möglichen Typen sind string, boolean, number und enum (mit seiner Optionsliste).

Eine Aktion Die von diesem Template verwendeten Variablen entdecken analysiert das Template und meldet die verwendeten, aber nicht deklarierten Variablen, um Auslassungen zu vermeiden.

Die Geltungsbereiche

Der Geltungsbereich entscheidet, auf welcher Ebene die Variable ausgewertet wird und wo sie im Kontext des Templates landet:

Geltungsbereich	Ausgewertet	Verfügbar im Template
Projekt	einmal	ctx.design.vars.<nom>
Modell	pro Modell	ctx.models[].vars.<nom>
Eigenschaft	pro Eigenschaft	ctx.models[].properties[].vars.<nom>
Route	pro Route	ctx.groups[].routes[].vars.<nom>

Allgemeiner Wert und Überschreiben

Für jedes Template definieren Sie allgemeine Werte pro Geltungsbereich (die „allgemeinen Variablen”, die zum Beispiel für alle Modelle gelten). Sie können anschließend eine Variable für ein bestimmtes Modell, eine bestimmte Eigenschaft oder eine bestimmte Route überschreiben, über den Tab Code generation dieser Entität. Ein leerer Wert bedeutet „erben”: der erste nicht leere Wert gewinnt, und jeder nicht aufgelöste Wert steigt als Fehler auf — niemals still.