add unit tests

pkg/utils/markdown_utils.go

@@ -9,17 +9,18 @@ import (
 	"os/exec"
 	"runtime/debug"
 
-	l "github.com/charmbracelet/log"
+	log "github.com/charmbracelet/log"
 	"golang.org/x/text/cases"
 	"golang.org/x/text/language"
 
 	"github.com/cloudposse/atmos/pkg/schema"
 	"github.com/cloudposse/atmos/pkg/ui/markdown"
 )
 
-// render is the global markdown renderer instance initialized via InitializeMarkdown
+// render is the global markdown renderer instance initialized via InitializeMarkdown.
 var render *markdown.Renderer
 
+// PrintErrorMarkdown prints an error message in Markdown format.
 func PrintErrorMarkdown(title string, err error, suggestion string) {
 	if err == nil {
 		return
@@ -43,12 +44,12 @@ func PrintErrorMarkdown(title string, err error, suggestion string) {
 		LogError(err)
 	}
 	// Print stack trace
-	if l.GetLevel() == l.DebugLevel {
+	if log.GetLevel() == log.DebugLevel {
 		debug.PrintStack()
 	}
 }
 
-// PrintfErrorMarkdown prints a formatted error message in markdown format
+// PrintfErrorMarkdown prints a formatted error message in Markdown format.
 func PrintfErrorMarkdown(format string, a ...interface{}) {
 	if render == nil {
 		LogError(fmt.Errorf(format, a...))
@@ -66,6 +67,7 @@ func PrintfErrorMarkdown(format string, a ...interface{}) {
 	LogError(err)
 }
 
+// PrintErrorMarkdownAndExit prints an error message in Markdown format and exist with the exit code 1.
 func PrintErrorMarkdownAndExit(title string, err error, suggestion string) {
 	PrintErrorMarkdown(title, err, suggestion)
 
@@ -78,10 +80,12 @@ func PrintErrorMarkdownAndExit(title string, err error, suggestion string) {
 	os.Exit(1)
 }
 
+// PrintInvalidUsageErrorAndExit prints a message about the incorrect command usage and exist with the exit code 1.
 func PrintInvalidUsageErrorAndExit(err error, suggestion string) {
 	PrintErrorMarkdownAndExit("Incorrect Usage", err, suggestion)
 }
 
+// PrintfMarkdown prints a message in Markdown format.
 func PrintfMarkdown(format string, a ...interface{}) {
 	if render == nil {
 		_, err := os.Stdout.WriteString(fmt.Sprintf(format, a...))
@@ -99,6 +103,7 @@ func PrintfMarkdown(format string, a ...interface{}) {
 	LogError(err)
 }
 
+// InitializeMarkdown initializes a new Markdown renderer.
 func InitializeMarkdown(atmosConfig schema.AtmosConfiguration) {
 	var err error
 	render, err = markdown.NewTerminalMarkdownRenderer(atmosConfig)