Update CLI help template function

Adds a function for formatting CLI help output to remove markdown
formatting for more than one header before printing to terminal.

Co-authored-by: Ben Blattberg <[email protected]>

Author: tjmoore4

internal/cmd/pgo.go

@@ -18,7 +18,7 @@ import (
 	"io"
 	"os"
 	"path/filepath"
-	"strings"
+	"regexp"
 
 	"github.com/spf13/cobra"
 	"k8s.io/cli-runtime/pkg/genericclioptions"
@@ -82,9 +82,9 @@ func NewPGOCommand(stdin io.Reader, stdout, stderr io.Writer) *cobra.Command {
 		SilenceErrors: true,
 	}
 
-	cobra.AddTemplateFunc("replaceAll", strings.ReplaceAll)
+	cobra.AddTemplateFunc("formatHeader", formatHeader)
 
-	root.SetHelpTemplate(`{{with .Long}}{{ replaceAll . "#### RBAC Requirements" "RBAC Requirements:" | trimTrailingWhitespaces }}
+	root.SetHelpTemplate(`{{with .Long}}{{ formatHeader . | trimTrailingWhitespaces }}
 
 {{end}}{{if or .Runnable .HasSubCommands}}{{.UsageString}}{{end}}`)
 
@@ -107,3 +107,9 @@ func NewPGOCommand(stdin io.Reader, stdout, stderr io.Writer) *cobra.Command {
 
 	return root
 }
+
+// formatHeader removes markdown header syntax for CLI help output
+func formatHeader(s string) string {
+	re := regexp.MustCompile(`#### (.*)\n`)
+	return re.ReplaceAllString(s, "$1:\n")
+}

internal/cmd/pgo_test.go

@@ -0,0 +1,42 @@
+// Copyright 2021 - 2023 Crunchy Data Solutions, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package cmd
+
+import (
+	"testing"
+
+	"gotest.tools/v3/assert"
+)
+
+func TestFormatHeader(t *testing.T) {
+	testsCases := []struct {
+		desc   string
+		input  string
+		output string
+	}{
+		{"Expected", "#### Some Header\n", "Some Header:\n"},
+		{"One valid, one not", "#### Some Header\n#### Another Header", "Some Header:\n#### Another Header"},
+		{"Two expected", "#### Some Header\n#### Another Header\n", "Some Header:\nAnother Header:\n"},
+		{"No newline", "#### Some Header", "#### Some Header"},
+		{"3 hashes", "### Some Header\n", "### Some Header\n"},
+		{"leading space", " #### Some Header\n", " Some Header:\n"},
+	}
+
+	for _, tc := range testsCases {
+		t.Run(tc.desc, func(t *testing.T) {
+			assert.Equal(t, formatHeader(tc.input), tc.output)
+		})
+	}
+}