Define an "AddComments" option veneer

docs/compiler_passes.md

@@ -325,6 +325,17 @@ between them.
 set_datasource_to_dataquery: {}
 ```
 
+## `trim_enum_values`
+
+TrimEnumValues removes leading and trailing spaces from string values.
+It could happen when they add them by mistake in jsonschema/openapi when they define the enums
+
+### Usage
+
+```yaml
+trim_enum_values: {}
+```
+
 ## `unspec`
 
 Unspec removes the Kubernetes-style envelope added by kindsys.

internal/veneers/option/actions.go

@@ -2,6 +2,7 @@ package option
 
 import (
 	"fmt"
+	"strings"
 
 	"github.com/grafana/cog/internal/ast"
 	"github.com/grafana/cog/internal/tools"
@@ -670,3 +671,13 @@ func AddAssignmentAction(assignment veneers.Assignment) RewriteAction {
 		return []ast.Option{option}
 	}
 }
+
+// AddCommentsAction adds comments to an option.
+func AddCommentsAction(comments []string) RewriteAction {
+	return func(_ ast.Schemas, builder ast.Builder, option ast.Option) []ast.Option {
+		option.Comments = append(option.Comments, comments...)
+		option.AddToVeneerTrail(fmt.Sprintf("AddComments[%s]", strings.Join(comments, " ")))
+
+		return []ast.Option{option}
+	}
+}

internal/veneers/option/rules.go

@@ -92,3 +92,10 @@ func AddAssignment(selector Selector, assignment veneers.Assignment) RewriteRule
 		Action:   AddAssignmentAction(assignment),
 	}
 }
+
+func AddComments(selector Selector, comments []string) RewriteRule {
+	return RewriteRule{
+		Selector: selector,
+		Action:   AddCommentsAction(comments),
+	}
+}

internal/yaml/option.go

@@ -24,6 +24,7 @@ type OptionRule struct {
 	DisjunctionAsOptions    *DisjunctionAsOptions    `yaml:"disjunction_as_options"`
 	Duplicate               *DuplicateOption         `yaml:"duplicate"`
 	AddAssignment           *AddAssignment           `yaml:"add_assignment"`
+	AddComments             *AddComments             `yaml:"add_comments"`
 }
 
 func (rule OptionRule) AsRewriteRule(pkg string) (option.RewriteRule, error) {
@@ -76,6 +77,10 @@ func (rule OptionRule) AsRewriteRule(pkg string) (option.RewriteRule, error) {
 		return rule.AddAssignment.AsRewriteRule(pkg)
 	}
 
+	if rule.AddComments != nil {
+		return rule.AddComments.AsRewriteRule(pkg)
+	}
+
 	return option.RewriteRule{}, fmt.Errorf("empty rule")
 }
 
@@ -223,6 +228,20 @@ func (rule AddAssignment) AsRewriteRule(pkg string) (option.RewriteRule, error)
 	return option.AddAssignment(selector, rule.Assignment), nil
 }
 
+type AddComments struct {
+	OptionSelector `yaml:",inline"`
+	Comments       []string `yaml:"comments"`
+}
+
+func (rule AddComments) AsRewriteRule(pkg string) (option.RewriteRule, error) {
+	selector, err := rule.AsSelector(pkg)
+	if err != nil {
+		return option.RewriteRule{}, err
+	}
+
+	return option.AddComments(selector, rule.Comments), nil
+}
+
 /******************************************************************************
  * Selectors
  *****************************************************************************/

schemas/veneers.json

@@ -380,6 +380,29 @@
       "additionalProperties": false,
       "type": "object"
     },
+    "YamlAddComments": {
+      "properties": {
+        "by_name": {
+          "type": "string",
+          "description": "objectName.optionName"
+        },
+        "by_builder": {
+          "type": "string",
+          "description": "builderName.optionName\nTODO: ByName should be called ByObject\nand ByBuilder should be called ByName"
+        },
+        "by_names": {
+          "$ref": "#/$defs/YamlByNamesSelector"
+        },
+        "comments": {
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        }
+      },
+      "additionalProperties": false,
+      "type": "object"
+    },
     "YamlAddOption": {
       "properties": {
         "by_object": {
@@ -732,6 +755,9 @@
         },
         "add_assignment": {
           "$ref": "#/$defs/YamlAddAssignment"
+        },
+        "add_comments": {
+          "$ref": "#/$defs/YamlAddComments"
         }
       },
       "additionalProperties": false,