add markdown format as alias for markup

Tufin · Feb 12, 2025 · 72fc958 · 72fc958
1 parent 04f9c59
commit 72fc958
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 5 deletions.
diff --git a/formatters/interface.go b/formatters/interface.go
@@ -27,6 +27,7 @@ var formatters = map[Format]Formatter{
 	FormatJSON:          JSONFormatter{},
 	FormatText:          TEXTFormatter{},
 	FormatMarkup:        MarkupFormatter{},
+	FormatMarkdown:      MarkupFormatter{},
 	FormatSingleLine:    SingleLineFormatter{},
 	FormatHTML:          HTMLFormatter{},
 	FormatGithubActions: GitHubActionsFormatter{},
@@ -45,7 +46,7 @@ func Lookup(format string, opts FormatterOpts) (Formatter, error) {
 		return newJSONFormatter(l), nil
 	case FormatText:
 		return newTEXTFormatter(l), nil
-	case FormatMarkup:
+	case FormatMarkup, FormatMarkdown:
 		return newMarkupFormatter(l), nil
 	case FormatSingleLine:
 		return newSingleLineFormatter(l), nil

diff --git a/formatters/interface_test.go b/formatters/interface_test.go
@@ -15,11 +15,12 @@ func TestUnsupportedLookup(t *testing.T) {
 
 func TestDiffOutputFormats(t *testing.T) {
 	supportedFormats := formatters.SupportedFormatsByContentType(formatters.OutputDiff)
-	assert.Len(t, supportedFormats, 5)
+	assert.Len(t, supportedFormats, 6)
 	assert.Contains(t, supportedFormats, string(formatters.FormatYAML))
 	assert.Contains(t, supportedFormats, string(formatters.FormatJSON))
 	assert.Contains(t, supportedFormats, string(formatters.FormatText))
 	assert.Contains(t, supportedFormats, string(formatters.FormatMarkup))
+	assert.Contains(t, supportedFormats, string(formatters.FormatMarkdown))
 	assert.Contains(t, supportedFormats, string(formatters.FormatHTML))
 }
 
@@ -32,11 +33,12 @@ func TestSummaryOutputFormats(t *testing.T) {
 
 func TestChangelogOutputFormats(t *testing.T) {
 	supportedFormats := formatters.SupportedFormatsByContentType(formatters.OutputChangelog)
-	assert.Len(t, supportedFormats, 8)
+	assert.Len(t, supportedFormats, 9)
 	assert.Contains(t, supportedFormats, string(formatters.FormatYAML))
 	assert.Contains(t, supportedFormats, string(formatters.FormatJSON))
 	assert.Contains(t, supportedFormats, string(formatters.FormatText))
 	assert.Contains(t, supportedFormats, string(formatters.FormatMarkup))
+	assert.Contains(t, supportedFormats, string(formatters.FormatMarkdown))
 	assert.Contains(t, supportedFormats, string(formatters.FormatSingleLine))
 	assert.Contains(t, supportedFormats, string(formatters.FormatHTML))
 	assert.Contains(t, supportedFormats, string(formatters.FormatGithubActions))

diff --git a/formatters/types.go b/formatters/types.go
@@ -9,6 +9,7 @@ const (
 	FormatJSON          Format = "json"
 	FormatText          Format = "text"
 	FormatMarkup        Format = "markup"
+	FormatMarkdown      Format = "markdown"
 	FormatSingleLine    Format = "singleline"
 	FormatHTML          Format = "html"
 	FormatGithubActions Format = "githubactions"
@@ -22,6 +23,7 @@ func GetSupportedFormats() []string {
 		string(FormatJSON),
 		string(FormatText),
 		string(FormatMarkup),
+		string(FormatMarkdown),
 		string(FormatSingleLine),
 		string(FormatHTML),
 		string(FormatGithubActions),

diff --git a/formatters/types_test.go b/formatters/types_test.go
@@ -8,5 +8,5 @@ import (
 )
 
 func TestTypes(t *testing.T) {
-	require.Equal(t, formatters.GetSupportedFormats(), []string{"yaml", "json", "text", "markup", "singleline", "html", "githubactions", "junit", "sarif"})
+	require.Equal(t, formatters.GetSupportedFormats(), []string{"yaml", "json", "text", "markup", "markdown", "singleline", "html", "githubactions", "junit", "sarif"})
 }
diff --git a/internal/viper_test.go b/internal/viper_test.go
@@ -82,7 +82,7 @@ func TestViper_InvalidFormat(t *testing.T) {
 
 	cmd := cobra.Command{}
 
-	require.EqualError(t, internal.RunViper(&cmd, v), "failed to load config file: invalid format \"invalid\", allowed values: yaml, json, text, markup, singleline, html, githubactions, junit, sarif")
+	require.EqualError(t, internal.RunViper(&cmd, v), "failed to load config file: invalid format \"invalid\", allowed values: yaml, json, text, markup, markdown, singleline, html, githubactions, junit, sarif")
 }
 
 func TestViper_InvalidFailOn(t *testing.T) {