Allow optional description for manifest variables (#3219)

Signed-off-by: Brian Hardock <[email protected]>

Author: fibonacci1729

crates/expressions/src/lib.rs

@@ -330,13 +330,15 @@ mod tests {
             (
                 "required".into(),
                 Variable {
+                    description: None,
                     default: None,
                     secret: false,
                 },
             ),
             (
                 "default".into(),
                 Variable {
+                    description: None,
                     default: Some("default-value".into()),
                     secret: false,
                 },

crates/loader/src/local.rs

@@ -764,6 +764,7 @@ fn locked_variable(variable: v2::Variable) -> Result<locked::Variable> {
         "must be `required` OR have a `default`"
     );
     Ok(locked::Variable {
+        description: variable.description,
         default: variable.default.clone(),
         secret: variable.secret,
     })

crates/locked-app/src/locked.rs

@@ -342,6 +342,9 @@ pub struct LockedTrigger {
 /// A Variable specifies a custom configuration variable.
 #[derive(Clone, Debug, Serialize, Deserialize)]
 pub struct Variable {
+    /// A brief description of the variable.
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub description: Option<String>,
     /// The variable's default value. If unset, the variable is required.
     #[serde(default, skip_serializing_if = "Option::is_none")]
     pub default: Option<String>,

crates/manifest/src/schema/common.rs

@@ -11,6 +11,13 @@ use super::json_schema;
 #[derive(Clone, Debug, Serialize, Deserialize, JsonSchema)]
 #[serde(deny_unknown_fields)]
 pub struct Variable {
+    /// A brief description of the variable.
+    ///
+    /// Example: `description = "This is a variable"`
+    ///
+    /// Learn more: https://spinframework.dev/variables#adding-variables-to-your-applications
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub description: Option<String>,
     /// Whether a value must be supplied at runtime. If not specified, required defaults
     /// to `false`, and `default` must be provided.
     ///

crates/manifest/tests/ui/maximal.json

@@ -21,6 +21,7 @@
   },
   "variables": {
     "var_one": {
+      "description": "Test me like one of your French strings!",
       "default": "Default"
     },
     "var_two": {

crates/manifest/tests/ui/maximal.toml

@@ -13,7 +13,7 @@ global_option = true
 lint_level = "savage"
 
 [variables]
-var_one = { default = "Default" }
+var_one = { description = "Test me like one of your French strings!", default = "Default" }
 var_two = { required = true, secret = true }
 
 [[trigger.fake]]