feat: add displaying default values (#31)

* feat: add displaying default values * changed color of default and added release notes
Skarlso · Nov 17, 2023 · b212114 · b212114
1 parent bef274c
commit b212114
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 4 deletions.
diff --git a/cmd/generate.go b/cmd/generate.go
@@ -7,12 +7,12 @@ import (
 	"os"
 	"path/filepath"
 
-	"github.com/Skarlso/crd-to-sample-yaml/pkg/fetcher"
 	"github.com/spf13/cobra"
 	"k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1beta1"
 	"k8s.io/apimachinery/pkg/util/yaml"
 
 	"github.com/Skarlso/crd-to-sample-yaml/pkg"
+	"github.com/Skarlso/crd-to-sample-yaml/pkg/fetcher"
 )
 
 var (

diff --git a/docs/release_notes/v0.1.2.md b/docs/release_notes/v0.1.2.md
@@ -0,0 +1,3 @@
+# v0.1.2 Release
+
+Display default values.
diff --git a/pkg/fetcher/fetch_content.go b/pkg/fetcher/fetch_content.go
@@ -6,7 +6,7 @@ import (
 	"net/http"
 )
 
-// Fetcher wraps an http client.
+// Fetcher wraps an HTTP client.
 type Fetcher struct {
 	client *http.Client
 }

diff --git a/pkg/generate.go b/pkg/generate.go
@@ -104,6 +104,10 @@ func parseProperties(group, version, kind string, properties map[string]v1beta1.
 
 // outputValueType generate an output value based on the given type.
 func outputValueType(v v1beta1.JSONSchemaProps) string {
+	if v.Default != nil {
+		return string(v.Default.Raw)
+	}
+
 	switch v.Type {
 	case "string":
 		return "string"

diff --git a/pkg/server.go b/pkg/server.go
@@ -218,6 +218,7 @@ type Property struct {
 	Format      string
 	Indent      int
 	Version     string
+	Default     string
 	Required    bool
 	Properties  []*Property
 }
@@ -256,6 +257,10 @@ func parseCRD(properties map[string]v1beta1.JSONSchemaProps, version string, req
 			Version:     version,
 			Required:    required,
 		}
+		if v.Default != nil {
+			p.Default = string(v.Default.Raw)
+		}
+
 		if len(properties[k].Properties) > 0 && properties[k].AdditionalProperties == nil {
 			requiredList = v.Required
 			out, err := parseCRD(properties[k].Properties, version, requiredList)

diff --git a/pkg/templates/view.html b/pkg/templates/view.html
@@ -52,12 +52,15 @@ <h1>
                 <details class="collapse-panel">
                     <summary class="collapse-header position-relative">
                         {{$v.Name}} <kbd class="text-muted">{{$v.Type}}</kbd>
-                        {{if .Format}}
+                        {{if $v.Format}}
                         <kbd class="text-muted">{{.Format}}</kbd>
                         {{end}}
-                        {{if .Patterns}}
+                        {{if $v.Patterns}}
                         <kbd class="text-muted">{{.Patterns}}</kbd>
                         {{end}}
+                        {{if $v.Default}}
+                        <kbd class="text-primary">{{$v.Default}}</kbd>
+                        {{end}}
                         {{if $v.Required}}
                         <span class="badge badge-primary">required</span>
                         {{end}}
@@ -105,6 +108,9 @@ <h1>
         {{if .Patterns}}
         <kbd class="text-muted">{{.Patterns}}</kbd>
         {{end}}
+        {{if .Default}}
+        <kbd class="text-primary">{{.Default}}</kbd>
+        {{end}}
         {{if .Required}}
         <span class="badge badge-primary">required</span>
         {{end}}