Enable setting defaults at the parameter level.

bigladder · Dec 17, 2024 · edd41cc · edd41cc
1 parent 454e14e
commit edd41cc
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 12 deletions.
diff --git a/templates/template-engine/TemplateParameter.cs b/templates/template-engine/TemplateParameter.cs
@@ -18,6 +18,7 @@ public class TemplateParameter
         public ParamType Type { get; set; }
         public bool IsOptional { get; set; }
         public Func<object, bool> Validate { get; set; }
+        public object? DefaultValue { get; set; }
 
         public TemplateParameter()
         {

diff --git a/templates/template-engine/Utils.cs b/templates/template-engine/Utils.cs
@@ -401,7 +401,17 @@ public static void
 			{
 				TemplateParameter tp = kvp.Value;
 				string optText = tp.IsOptional ? " (optional)" : "";
-				Console.WriteLine($"- {kvp.Key}{optText}: {tp.Type}");
+				string defaultValue = "";
+				if (tp.DefaultValue != null)
+				{
+					defaultValue = (tp.DefaultValue.ToString() ?? "").Trim();
+					if (defaultValue.Length > 0)
+					{
+						defaultValue = $" (default: {defaultValue})";
+					}
+				}
+				Console.WriteLine(
+					$"- {kvp.Key}{optText}{defaultValue}: {tp.Type}");
 			}
 		}
 
@@ -438,10 +448,16 @@ bool isOptional
 				string paramName = paramKvp.Key;
 				TomlTable singleParam = (TomlTable)paramKvp.Value;
 				string paramTypeAsStr = Get<string>(singleParam, "type");
+				object? defaultValue = null;
+				if (paramTable.ContainsKey("default"))
+				{
+					defaultValue = paramTable["default"];
+				}
 				ParamType paramType = StringToParamType(paramTypeAsStr);
 				if (paramType == ParamType.Unhandled)
 				{
-					throw new Exception($"[ERROR] Unhandled parameter type for '{paramName}' ({paramTypeAsStr})");
+					throw new Exception(
+						$"[ERROR] Unhandled parameter type for '{paramName}' ({paramTypeAsStr})");
 				}
 				switch (paramType)
 				{
@@ -466,6 +482,7 @@ bool isOptional
 								catch {}
 								return false;
 							},
+							DefaultValue = defaultValue,
 						};
 						parameters.Add(paramName, tp);
 					}
@@ -486,6 +503,7 @@ bool isOptional
 								catch {}
 								return false;
 							},
+							DefaultValue = defaultValue,
 						};
 						parameters.Add(paramName, tp);
 					}
@@ -506,6 +524,7 @@ bool isOptional
 								catch {}
 								return false;
 							},
+							DefaultValue = defaultValue,
 						};
 						parameters.Add(paramName, tp);
 					}
@@ -526,6 +545,7 @@ bool isOptional
 								catch {}
 								return false;
 							},
+							DefaultValue = defaultValue,
 						};
 						parameters.Add(paramName, tp);
 					}
@@ -546,6 +566,7 @@ bool isOptional
 								catch {}
 								return false;
 							},
+							DefaultValue = defaultValue,
 						};
 						parameters.Add(paramName, tp);
 					}
@@ -571,6 +592,7 @@ bool isOptional
 								catch {}
 								return false;
 							},
+							DefaultValue = defaultValue,
 						};
 						parameters.Add(paramName, tp);
 					}
@@ -612,6 +634,7 @@ bool isOptional
 								catch {}
 								return false;
 							},
+							DefaultValue = defaultValue,
 						};
 						parameters.Add(paramName, tp);
 					}
@@ -791,10 +814,23 @@ public static TomlTable
 						{
 							defaultValue = fieldValue["default"];
 						}
+						else if (parameters.TryGetValue(
+							fieldName, out TemplateParameter? tp))
+						{
+							defaultValue = tp.DefaultValue;
+						}
+						string defaultStr = "";
+						if (defaultValue != null)
+						{
+							string def = defaultValue.ToString() ?? "";
+							defaultStr = $" (default: {def})";
+						}
 						if (verbose)
 						{
 							Console.WriteLine(
-								$"[INFO] Found field '{fieldName}' parameterized on '{paramName}' {templateInfo}"
+								$"[INFO] Found field '{fieldName}' "
+								+ $"parameterized on '{paramName}' "
+								+ $"{templateInfo} {defaultStr}"
 							);
 						}
 					}
@@ -803,19 +839,15 @@ public static TomlTable
 				{}
 				if (isParam)
 				{
-					if (!component.ContainsKey(paramName))
+					TemplateParameter tp = parameters[paramName];
+					if (!tp.IsOptional && !component.ContainsKey(paramName))
 					{
-						throw new Exception($"[ERROR] Component missing param {paramName} {templateInfo}");
+						throw new Exception($"[ERROR] Missing required param '{paramName}' {templateInfo}");
 					}
 					if (!parameters.ContainsKey(paramName))
 					{
 						throw new Exception($"[ERROR] Reference to undefined parameter {paramName} {templateInfo}");
 					}
-					TemplateParameter tp = parameters[paramName];
-					if (!tp.IsOptional && !component.ContainsKey(paramName))
-					{
-						throw new Exception($"[ERROR] Missing required param '{paramName}' {templateInfo}");
-					}
 					object? paramValue = null;
 					if (component.ContainsKey(paramName))
 					{
@@ -825,15 +857,17 @@ public static TomlTable
 					{
 						if (!tp.Validate(paramValue))
 						{
-							throw new Exception($"[ERROR] Invalid value for parameter {paramName} {templateInfo}");
+							throw new Exception(
+								$"[ERROR] Invalid value for parameter {paramName} {templateInfo}");
 						}
 						toAdd.Add(fieldName, paramValue);
 					}
 					else if (defaultValue != null)
 					{
 						if (!tp.Validate(defaultValue))
 						{
-							throw new Exception($"[ERROR] Invalid default value for parameter {paramName} {templateInfo}");
+							throw new Exception(
+								$"[ERROR] Invalid default value for parameter {paramName} {templateInfo}");
 						}
 						toAdd.Add(fieldName, defaultValue);
 					}