improved multi-line support in mardown table

Author: brahmlower

cmd/helm-values/internal/commands/docs.go

@@ -188,9 +188,28 @@ func schemaProperties(schema *jsonschema.Schema, parents []string) []docs.Values
 			fmt.Printf("Error marshaling default value for key %s: %v\n", key, err)
 		}
 
+		typeValue := prop.Type
+		if len(prop.Enum) > 0 {
+			enumItems := make([]string, len(prop.Enum))
+			for i, enumItem := range prop.Enum {
+				enumBytes, err := json.Marshal(enumItem)
+				if err != nil {
+					// TODO: Handle this error better
+					continue
+				}
+				enumItems[i] = string(enumBytes)
+			}
+
+			typeValue = fmt.Sprintf(
+				"%s (enum)\n%s",
+				typeValue,
+				strings.Join(enumItems, ", "),
+			)
+		}
+
 		row := docs.ValuesRow{
 			Key:         strings.Join(append(parents, key), "."),
-			Type:        prop.Type,
+			Type:        typeValue,
 			Default:     string(defaultStr),
 			Description: prop.Description,
 		}

cmd/helm-values/internal/docs/templates.go

@@ -84,6 +84,7 @@ func (b *TemplateBuilder) Build(fsys fs.FS) (*template.Template, error) {
 	funcMap["maxLen"] = maxLen
 	funcMap["rowSelect"] = rowSelect
 	funcMap["mdRow"] = mdRow
+	funcMap["mdMultiline"] = mdMultiline
 
 	return template.New(b.TemplateName()).
 		Funcs(funcMap).

cmd/helm-values/internal/docs/templates/markdown/valuesTable.md.gotmpl

@@ -1,18 +1,14 @@
 
 {{- define "md.valuesTable" }}
-{{ $cwKey := add (maxLen (rowSelect .ValuesTable "Key")) 1 }}
-{{ $cwType := add (maxLen (rowSelect .ValuesTable "Type")) 1 }}
-{{ $cwDefault := add (maxLen (rowSelect .ValuesTable "Default")) 1 }}
-{{ $cwDescription := add (maxLen (rowSelect .ValuesTable "Description")) 1 }}
 
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
 {{- range .ValuesTable }}
 {{- "\n" }}
-{{- printf "| %s" (rpad .Key " " $cwKey) }}
-{{- printf "| %s" (rpad .Type " " $cwType) }}
-{{- printf "| %s" (rpad .Default " " $cwDefault) }}
-{{- printf "| %s" (rpad (.Description | replace "\n" "<br>") " " $cwDescription) }}
+{{- printf "| %s " (mdMultiline .Key) }}
+{{- printf "| %s " (mdMultiline .Type) }}
+{{- printf "| `%s` " (mdMultiline .Default) }}
+{{- printf "| %s " (mdMultiline .Description) }}
 {{- "|" }}
 {{- end }}
 {{- end }}

cmd/helm-values/internal/docs/tmpl_funcs.go

@@ -58,3 +58,7 @@ func mdRow(cols []string, colWidths []int64) string {
 
 	return fmt.Sprintf("| %s |", strings.Join(c, " | "))
 }
+
+func mdMultiline(s string) string {
+	return strings.ReplaceAll(s, "\n", "</br>")
+}