Refactor code to take into account optional fields

Refactor code so we are not passing in values and only using the defaults from the module config

Show parent field if there are no child fields to show

We want to show the labels field (among others) in the markdown table if
so that it is part of the documentation rather than showing all the
preset labels as individual fields in the docs.

Signed-off-by: Luke Mallon (Nalum) <[email protected]>

Update schema with +nodoc tags and copy to blueprint starter module

Hide certain fields

This change brings the output more inline with the definition

Update output to remove default column

Commit updated test data

Signed-off-by: Luke Mallon (Nalum) <[email protected]>

Update nodoc behaviour

Signed-off-by: Luke Mallon (Nalum) <[email protected]>

Update structure to accomodate nodoc

Signed-off-by: Luke Mallon (Nalum) <[email protected]>

Merge branch 'main' into module-md-optional-fields

Author: nalum

blueprints/starter/README.md

@@ -30,6 +30,7 @@ import (
 
 	// Reference is the image address computed from repository, tag and digest
 	// in the format [REPOSITORY]:[TAG]@[DIGEST].
+	// +nodoc
 	reference: string
 
 	if digest != "" && tag != "" {

blueprints/starter/cue.mod/pkg/timoni.sh/core/v1alpha1/image.cue

@@ -43,13 +43,17 @@ import "strings"
 
 	// Standard Kubernetes labels: app name, version and managed-by.
 	labels: {
-		(#StdLabelName):      name
-		(#StdLabelVersion):   #Version
+		// +nodoc
+		(#StdLabelName): name
+		// +nodoc
+		(#StdLabelVersion): #Version
+		// +nodoc
 		(#StdLabelManagedBy): "timoni"
 	}
 
 	// LabelSelector selects Pods based on the app.kubernetes.io/name label.
 	#LabelSelector: #Labels & {
+		// +nodoc
 		(#StdLabelName): name
 	}
 
@@ -74,6 +78,7 @@ import "strings"
 	namespace: #Meta.namespace
 
 	labels: #Meta.labels
+	// +nodoc
 	labels: (#StdLabelComponent): #Component
 
 	annotations?: #Annotations
@@ -84,8 +89,10 @@ import "strings"
 	// LabelSelector selects Pods based on the app.kubernetes.io/name
 	// and app.kubernetes.io/component labels.
 	#LabelSelector: #Labels & {
+		// +nodoc
 		(#StdLabelComponent): #Component
-		(#StdLabelName):      #Meta.name
+		// +nodoc
+		(#StdLabelName): #Meta.name
 	}
 }
 
@@ -104,6 +111,7 @@ import "strings"
 	name: #Meta.name + "-" + #Component
 
 	labels: #Meta.labels
+	// +nodoc
 	labels: (#StdLabelComponent): #Component
 
 	annotations?: #Annotations
@@ -114,7 +122,9 @@ import "strings"
 	// LabelSelector selects Pods based on the app.kubernetes.io/name
 	// and app.kubernetes.io/component labels.
 	#LabelSelector: #Labels & {
+		// +nodoc
 		(#StdLabelComponent): #Component
-		(#StdLabelName):      #Meta.name
+		// +nodoc
+		(#StdLabelName): #Meta.name
 	}
 }

blueprints/starter/cue.mod/pkg/timoni.sh/core/v1alpha1/metadata.cue

@@ -15,5 +15,8 @@ package v1alpha1
 	labels: #Labels
 
 	// Standard Kubernetes label: app name.
-	labels: (#StdLabelName): #Name
+	labels: {
+		// +nodoc
+		(#StdLabelName): #Name
+	}
 }

blueprints/starter/cue.mod/pkg/timoni.sh/core/v1alpha1/selector.cue

@@ -21,9 +21,11 @@ import (
 	let minMajor = strconv.Atoi(strings.Split(#Minimum, ".")[0])
 	let minMinor = strconv.Atoi(strings.Split(#Minimum, ".")[1])
 
+	// +nodoc
 	major: int & >=minMajor
 	major: strconv.Atoi(strings.Split(#Version, ".")[0])
 
+	// +nodoc
 	minor: int & >=minMinor
 	minor: strconv.Atoi(strings.Split(#Version, ".")[1])
 }

blueprints/starter/cue.mod/pkg/timoni.sh/core/v1alpha1/semver.cue

@@ -9,13 +9,16 @@ import (
 #Config: {
 	// The kubeVersion is a required field, set at apply-time
 	// via timoni.cue by querying the user's Kubernetes API.
+	// +nodoc
 	kubeVersion!: string
 	// Using the kubeVersion you can enforce a minimum Kubernetes minor version.
 	// By default, the minimum Kubernetes version is set to 1.20.
+	// +nodoc
 	clusterVersion: timoniv1.#SemVer & {#Version: kubeVersion, #Minimum: "1.20.0"}
 
 	// The moduleVersion is set from the user-supplied module version.
 	// This field is used for the `app.kubernetes.io/version` label.
+	// +nodoc
 	moduleVersion!: string
 
 	// The Kubernetes metadata common to all resources.

blueprints/starter/templates/config.cue

@@ -40,13 +40,13 @@ import (
 
 var configShowModCmd = &cobra.Command{
 	Use:   "config [MODULE PATH]",
-	Short: "Output the #Config structure of a local module",
+	Short: "Output the `#Config` structure of a local module",
 	Long:  `The config command parses the local module configuration structure and outputs the information to stdout.`,
 	Example: `  # print the config of a module in the current directory
   timoni mod show config
 
-  # output the config to a file, if the file is markdown, the table will overwrite a table in a Configuration section or
-  # be appended to the end of the file
+  # output the config to a file, if the file is markdown, the table will overwrite a table in the ## Configuration section
+  # under the sub heading ### General values or be appended to the end of the file
   timoni mod show config --output ./README.md
 `,
 	RunE: runConfigShowModCmd,
@@ -115,7 +115,7 @@ func runConfigShowModCmd(cmd *cobra.Command, args []string) error {
 		configShowModArgs.pkg.String(),
 	)
 
-	if err := builder.WriteSchemaFile(); err != nil {
+	if err = builder.WriteSchemaFile(); err != nil {
 		return err
 	}
 
@@ -124,17 +124,16 @@ func runConfigShowModCmd(cmd *cobra.Command, args []string) error {
 		return fmt.Errorf("build failed: %w", err)
 	}
 
-	buildResult, err := builder.Build()
+	_, err = builder.Build()
 	if err != nil {
 		return describeErr(f.GetModuleRoot(), "validation failed", err)
 	}
-
-	rows, err := builder.GetConfigDoc(buildResult)
+	rows, err := builder.GetConfigDoc()
 	if err != nil {
 		return describeErr(f.GetModuleRoot(), "failed to get config structure", err)
 	}
 
-	header := []string{"Key", "Type", "Default", "Description"}
+	header := []string{"Key", "Type", "Description"}
 
 	if configShowModArgs.output == "" {
 		printMarkDownTable(rootCmd.OutOrStdout(), header, rows)
@@ -158,36 +157,49 @@ func writeFile(readFile string, header []string, rows [][]string, f fetcher.Fetc
 	var tableBuffer bytes.Buffer
 	tableWriter := bufio.NewWriter(&tableBuffer)
 	printMarkDownTable(tableWriter, header, rows)
-	tableWriter.Flush()
+	err := tableWriter.Flush()
+	if err != nil {
+		return "", describeErr(f.GetModuleRoot(), "Unable to create the temporary output file", err)
+	}
 	// get a temporary file name
 	tmpFileName := readFile + ".tmp"
 	// open the input file
 	inputFile, err := os.Open(readFile)
 	if err != nil {
 		if errors.Is(err, fs.ErrNotExist) {
 			inputFile, err = os.Create(readFile)
-
 			if err != nil {
 				return "", describeErr(f.GetModuleRoot(), "Unable to create the temporary output file", err)
 			}
 		} else {
 			return "", describeErr(f.GetModuleRoot(), "Unable to create the temporary output file", err)
 		}
 	}
-	defer inputFile.Close()
+	fileClose := func(file *os.File) {
+		err = file.Close()
+		if err != nil {
+			fmt.Println(describeErr(f.GetModuleRoot(), "Unable to create the temporary output file", err))
+		}
+	}
+	defer fileClose(inputFile)
 
 	// open the output file
 	outputFile, err := os.Create(tmpFileName)
 	if err != nil {
 		return "", describeErr(f.GetModuleRoot(), "Unable to create the temporary output file", err)
 	}
-	defer outputFile.Close()
+	defer fileClose(outputFile)
 
 	// Create the scanner and writer
 	inputScanner := bufio.NewScanner(inputFile)
 	outputWriter := bufio.NewWriter(outputFile)
 	var configSection bool
+	var generalValuesSection bool
 	var foundTable bool
+	regex, err := regexp.Compile(`^\|.*\|$`)
+	if err != nil {
+		return "", describeErr(f.GetModuleRoot(), "Unalbe to compile the regex check", err)
+	}
 
 	// Scan the input file line by line to find the table and replace it or append it to the end
 	for inputScanner.Scan() {
@@ -197,29 +209,40 @@ func writeFile(readFile string, header []string, rows [][]string, f fetcher.Fetc
 			if !configSection && line == "## Configuration" {
 				configSection = true
 			}
-
-			matched, err := regexp.MatchString(`^\|.*\|$`, line)
-			if err != nil {
-				return "", describeErr(f.GetModuleRoot(), "Regex Match for table content failed", err)
+			if !generalValuesSection && line == "### General values" {
+				generalValuesSection = true
 			}
 
-			if configSection && !foundTable && matched {
+			matched := regex.MatchString(line)
+			if configSection && generalValuesSection && !foundTable && matched {
 				foundTable = true
-				outputWriter.WriteString(tableBuffer.String() + "\n")
-			} else if configSection && foundTable && matched {
-			} else if configSection && foundTable && !matched {
+				_, err = outputWriter.WriteString(tableBuffer.String() + "\n")
+				if err != nil {
+					return "", describeErr(f.GetModuleRoot(), "Unable to create the temporary output file", err)
+				}
+			} else if configSection && generalValuesSection && foundTable && matched {
+			} else if configSection && generalValuesSection && foundTable && !matched {
 				configSection = false
 			} else {
-				outputWriter.WriteString(line + "\n")
+				_, err = outputWriter.WriteString(line + "\n")
+				if err != nil {
+					return "", describeErr(f.GetModuleRoot(), "Unable to create the temporary output file", err)
+				}
 			}
 		} else {
-			outputWriter.WriteString(line + "\n")
+			_, err = outputWriter.WriteString(line + "\n")
+			if err != nil {
+				return "", describeErr(f.GetModuleRoot(), "Unable to create the temporary output file", err)
+			}
 		}
 	}
 
 	// If no table was found, append it to the end of the file
 	if !foundTable {
-		outputWriter.WriteString("\n" + tableBuffer.String())
+		_, err = outputWriter.WriteString("\n" + tableBuffer.String())
+		if err != nil {
+			return "", describeErr(f.GetModuleRoot(), "Unable to create the temporary output file", err)
+		}
 	}
 
 	err = outputWriter.Flush()