Merge pull request #31 from norwoodj/improve-custom-default-rendering

chore: slightly changes format of @default values as they're rendered…

Author: norwoodj

example-charts/custom-template/README.md

@@ -29,7 +29,7 @@ culpa qui officia deserunt mollit anim id est laborum.
 | controller.image.tag | string | `"18.0831"` |  |
 | controller.ingressClass | string | `"nginx"` | Name of the ingress class to route through this controller |
 | controller.name | string | `"controller"` |  |
-| controller.persistentVolumeClaims | list | Use this to override the default value specified here in the file | List of persistent volume claims to create. For very long comments, break them into multiple lines. |
+| controller.persistentVolumeClaims | list | `["default", "specified", "here"]` | List of persistent volume claims to create. For very long comments, break them into multiple lines. |
 | controller.podLabels | object | `{}` | The labels to be applied to instances of the controller pod |
 | controller.publishService.enabled | bool | `false` | Whether to expose the ingress controller to the public world |
 | controller.replicas | int | `nil` | Number of nginx-ingress pods to load balance between |

example-charts/custom-template/values.yaml

@@ -6,7 +6,7 @@ controller:
 
   # controller.persistentVolumeClaims -- List of persistent volume claims to create.
   # For very long comments, break them into multiple lines.
-  # @default -- Use this to override the default value specified here in the file
+  # @default -- ["default", "specified", "here"]
   persistentVolumeClaims: []
 
   extraVolumes:

go.mod

@@ -1,5 +1,7 @@
 module github.com/norwoodj/helm-docs
 
+go 1.14
+
 require (
 	github.com/Masterminds/goutils v1.1.0 // indirect
 	github.com/Masterminds/semver v1.4.2 // indirect

pkg/document/values.go

@@ -95,19 +95,20 @@ func createValueRow(
 		return parseNilValueType(key, description), nil
 	}
 
-	if description.Default == "" {
+	defaultValue := description.Default
+	if defaultValue == "" {
 		jsonEncodedValue, err := json.Marshal(value)
 		if err != nil {
 			return valueRow{}, fmt.Errorf("failed to marshal default value for %s to json: %s", key, err)
 		}
 
-		description.Default = fmt.Sprintf("`%s`", jsonEncodedValue)
+		defaultValue = string(jsonEncodedValue)
 	}
 
 	return valueRow{
 		Key:         key,
 		Type:        getTypeName(value),
-		Default:     description.Default,
+		Default:     fmt.Sprintf("`%s`", defaultValue),
 		Description: description.Description,
 	}, nil
 }