Merge pull request #35 from losisin/feature/add-title

add title field to schema from comments

.github/workflows/ci.yaml

@@ -18,7 +18,7 @@ jobs:
         with:
           fetch-depth: 0
       - name: Set Helm
-        uses: azure/setup-helm@v3
+        uses: azure/setup-helm@v4.0.0
         with:
           version: v3.12.1
       - name: Set up Go
@@ -37,6 +37,6 @@ jobs:
       - name: Run plugin
         run: helm schema -help
       - name: Upload coverage reports to Codecov
-        uses: codecov/codecov-action@v4
+        uses: codecov/codecov-action@v3
         with:
           flags: unittests

docs/README.md

@@ -37,6 +37,8 @@ The following annotations are supported:
     * [minProperties](#minproperties)
     * [maxProperties](#maxproperties)
     * [required](#required)
+* [Meta-Data Annotations](#meta-data-annotations)
+    * [title](#title)
 
 ## Validation Keywords for Any Instance Type
 
@@ -364,3 +366,20 @@ image:
     "type": "object"
 }
 ```
+
+## Meta-Data Annotations
+
+### title
+
+String. [section 9.1](https://json-schema.org/draft/2020-12/json-schema-validation#section-9.1)
+
+```yaml
+fullnameOverride: bar # @schema title: My title
+```
+
+```json
+"fullnameOverride": {
+    "title": "My title",
+    "type": "string"
+},
+```

pkg/parser.go

@@ -50,6 +50,9 @@ func mergeSchemas(dest, src *Schema) *Schema {
 	if src.MinProperties != nil {
 		dest.MinProperties = src.MinProperties
 	}
+	if src.Title != "" {
+		dest.Title = src.Title
+	}
 
 	// Merge 'enum' field (assuming that maintaining order doesn't matter)
 	dest.Enum = append(dest.Enum, src.Enum...)
@@ -137,6 +140,9 @@ func convertSchemaToMapRec(schema *Schema, visited map[uintptr]bool) (map[string
 	if schema.MinProperties != nil {
 		schemaMap["minProperties"] = *schema.MinProperties
 	}
+	if schema.Title != "" {
+		schemaMap["title"] = schema.Title
+	}
 
 	// Arrays
 	if len(schema.Required) > 0 {

pkg/parser_test.go

@@ -21,7 +21,7 @@ func schemasEqual(a, b *Schema) bool {
 		return a == b
 	}
 	// Compare simple fields
-	if a.Type != b.Type || a.Pattern != b.Pattern || a.UniqueItems != b.UniqueItems {
+	if a.Type != b.Type || a.Pattern != b.Pattern || a.UniqueItems != b.UniqueItems || a.Title != b.Title {
 		return false
 	}
 	// Compare pointer fields
@@ -138,9 +138,9 @@ func TestMergeSchemas(t *testing.T) {
 		},
 		{
 			name: "string properties",
-			dest: &Schema{Type: "string", Pattern: "^abc", MinLength: uint64Ptr(1), MaxLength: uint64Ptr(10)},
-			src:  &Schema{Type: "string", Pattern: "^abc", MinLength: uint64Ptr(1), MaxLength: uint64Ptr(10)},
-			want: &Schema{Type: "string", Pattern: "^abc", MinLength: uint64Ptr(1), MaxLength: uint64Ptr(10)},
+			dest: &Schema{Type: "string", Pattern: "^abc", Title: "My Title", MinLength: uint64Ptr(1), MaxLength: uint64Ptr(10)},
+			src:  &Schema{Type: "string", Pattern: "^abc", Title: "My Title", MinLength: uint64Ptr(1), MaxLength: uint64Ptr(10)},
+			want: &Schema{Type: "string", Pattern: "^abc", Title: "My Title", MinLength: uint64Ptr(1), MaxLength: uint64Ptr(10)},
 		},
 		{
 			name: "array properties",
@@ -232,6 +232,7 @@ func TestConvertSchemaToMap(t *testing.T) {
 				Maximum:    float64Ptr(10),
 				Minimum:    float64Ptr(1),
 				Pattern:    "^abc",
+				Title:      "My Title",
 				Enum:       []interface{}{1, 2, 3},
 			},
 			want: map[string]interface{}{
@@ -240,6 +241,7 @@ func TestConvertSchemaToMap(t *testing.T) {
 				"maximum":    10.0,
 				"minimum":    1.0,
 				"pattern":    "^abc",
+				"title":      "My Title",
 				"enum":       []interface{}{1, 2, 3},
 			},
 		},

pkg/schema.go

@@ -11,6 +11,7 @@ import (
 type Schema struct {
 	Type          interface{}        `json:"type,omitempty"`
 	Enum          []any              `json:"enum,omitempty"`
+	Title         string             `json:"title,omitempty"`
 	MultipleOf    *float64           `json:"multipleOf,omitempty"`
 	Maximum       *float64           `json:"maximum,omitempty"`
 	Minimum       *float64           `json:"minimum,omitempty"`
@@ -157,6 +158,8 @@ func processComment(schema *Schema, comment string) (isRequired bool) {
 				}
 			case "type":
 				schema.Type = processList(value, true)
+			case "title":
+				schema.Title = value
 			}
 		}
 	}

pkg/schema_test.go

@@ -290,8 +290,8 @@ func TestProcessComment(t *testing.T) {
 		{
 			name:             "Set string",
 			schema:           &Schema{},
-			comment:          "# @schema pattern:^abv$;minLength:2;maxLength:10",
-			expectedSchema:   &Schema{Pattern: "^abv$", MinLength: uint64Ptr(2), MaxLength: uint64Ptr(10)},
+			comment:          "# @schema pattern:^abv$;title:My Title;minLength:2;maxLength:10",
+			expectedSchema:   &Schema{Pattern: "^abv$", Title: "My Title", MinLength: uint64Ptr(2), MaxLength: uint64Ptr(10)},
 			expectedRequired: false,
 		},
 		{
@@ -308,18 +308,6 @@ func TestProcessComment(t *testing.T) {
 			expectedSchema:   &Schema{MinProperties: uint64Ptr(1), MaxProperties: uint64Ptr(10)},
 			expectedRequired: false,
 		},
-		// {
-		// 	name: "Set required",
-		// 	schema: &Schema{
-		// 		Type: "object",
-		// 		Properties: map[string]*Schema{
-		// 			"shared": {Type: "string"},
-		// 		},
-		// 	},
-		// 	comment:          "# @schema required:true",
-		// 	expectedSchema:   &Schema{Required: []string{"shared"}},
-		// 	expectedRequired: true,
-		// },
 	}
 
 	for _, tt := range tests {

testdata/full.schema.json

@@ -89,9 +89,8 @@
             ]
         },
         "fullnameOverride": {
-            "maxLength": 10,
-            "minLength": 1,
             "pattern": "^[a-z]$",
+            "title": "My title",
             "type": "string"
         },
         "image": {

testdata/full.yaml

@@ -15,7 +15,7 @@ empty: # @schema type: [string, null]
 replicas: 2 # @schema minimum: 1 ; maximum: 10 ; multipleOf: 2
 
 # Strings
-fullnameOverride: bar # @schema pattern: ^[a-z]$ ; minLength: 1 ; maxLength: 10
+fullnameOverride: bar # @schema pattern: ^[a-z]$ ; title: My title
 
 # Arrays
 tolerations: # @schema minItems: 1 ; maxItems: 10 ; uniqueItems: true