option to wrap changes in object (#692)

reuvenharrison · web-flow · commit 2e713222f785 · 2025-04-16T10:11:17.000+03:00
diff --git a/formatters/format_json.go b/formatters/format_json.go
@@ -30,7 +30,7 @@ func (f JSONFormatter) RenderSummary(diff *diff.Diff, opts RenderOpts) ([]byte,
 }
 
 func (f JSONFormatter) RenderChangelog(changes checker.Changes, opts RenderOpts, specInfoPair *load.SpecInfoPair) ([]byte, error) {
-	return printJSON(NewChanges(changes, f.Localizer))
+	return printJSON(adaptStructure(NewChanges(changes, f.Localizer), opts.WrapInObject))
 }
 
 func (f JSONFormatter) RenderChecks(checks Checks, opts RenderOpts) ([]byte, error) {
@@ -57,3 +57,11 @@ func printJSON(output interface{}) ([]byte, error) {
 
 	return bytes, nil
 }
+
+func adaptStructure(output any, wrapInObject bool) any {
+	if wrapInObject {
+		output = map[string]any{"changes": output}
+	}
+
+	return output
+}
diff --git a/formatters/format_yaml.go b/formatters/format_yaml.go
@@ -30,7 +30,7 @@ func (f YAMLFormatter) RenderSummary(diff *diff.Diff, opts RenderOpts) ([]byte,
 }
 
 func (f YAMLFormatter) RenderChangelog(changes checker.Changes, opts RenderOpts, specInfoPair *load.SpecInfoPair) ([]byte, error) {
-	return printYAML(NewChanges(changes, f.Localizer))
+	return printYAML(adaptStructure(NewChanges(changes, f.Localizer), opts.WrapInObject))
 }
 
 func (f YAMLFormatter) RenderChecks(checks Checks, opts RenderOpts) ([]byte, error) {
diff --git a/formatters/format_yaml_test.go b/formatters/format_yaml_test.go
@@ -1,6 +1,7 @@
 package formatters_test
 
 import (
+	"strings"
 	"testing"
 
 	"github.com/oasdiff/oasdiff/checker"
@@ -31,6 +32,19 @@ func TestYamlFormatter_RenderChangelog(t *testing.T) {
 	require.Equal(t, "- id: change_id\n  text: This is a breaking change.\n  level: 3\n  section: components\n", string(out))
 }
 
+func TestYamlFormatter_RenderChangelogWithWrapInObject(t *testing.T) {
+	testChanges := checker.Changes{
+		checker.ComponentChange{
+			Id:    "change_id",
+			Level: checker.ERR,
+		},
+	}
+
+	out, err := yamlFormatter.RenderChangelog(testChanges, formatters.RenderOpts{WrapInObject: true}, nil)
+	require.NoError(t, err)
+	require.True(t, strings.HasPrefix(string(out), "changes:"))
+}
+
 func TestYamlFormatter_RenderChecks(t *testing.T) {
 	checks := formatters.Checks{
 		{
diff --git a/formatters/types.go b/formatters/types.go
@@ -39,7 +39,8 @@ type FormatterOpts struct {
 
 // RenderOpts can be used to pass properties to the renderer method
 type RenderOpts struct {
-	ColorMode checker.ColorMode
+	ColorMode    checker.ColorMode
+	WrapInObject bool // wrap the output in a JSON object with the key "changes"
 }
 
 func NewRenderOpts() RenderOpts {

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ func (f JSONFormatter) RenderSummary(diff *diff.Diff, opts RenderOpts) ([]byte,`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`func (f JSONFormatter) RenderChangelog(changes checker.Changes, opts RenderOpts, specInfoPair *load.SpecInfoPair) ([]byte, error) {`
`33`		`- return printJSON(NewChanges(changes, f.Localizer))`
	`33`	`+ return printJSON(adaptStructure(NewChanges(changes, f.Localizer), opts.WrapInObject))`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`func (f JSONFormatter) RenderChecks(checks Checks, opts RenderOpts) ([]byte, error) {`
`@@ -57,3 +57,11 @@ func printJSON(output interface{}) ([]byte, error) {`
`57`	`57`
`58`	`58`	`return bytes, nil`
`59`	`59`	`}`
	`60`	`+`
	`61`	`+func adaptStructure(output any, wrapInObject bool) any {`
	`62`	`+ if wrapInObject {`
	`63`	`+ output = map[string]any{"changes": output}`
	`64`	`+ }`
	`65`	`+`
	`66`	`+ return output`
	`67`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ func (f YAMLFormatter) RenderSummary(diff *diff.Diff, opts RenderOpts) ([]byte,`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`func (f YAMLFormatter) RenderChangelog(changes checker.Changes, opts RenderOpts, specInfoPair *load.SpecInfoPair) ([]byte, error) {`
`33`		`- return printYAML(NewChanges(changes, f.Localizer))`
	`33`	`+ return printYAML(adaptStructure(NewChanges(changes, f.Localizer), opts.WrapInObject))`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`func (f YAMLFormatter) RenderChecks(checks Checks, opts RenderOpts) ([]byte, error) {`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,8 @@ type FormatterOpts struct {`
`39`	`39`
`40`	`40`	`// RenderOpts can be used to pass properties to the renderer method`
`41`	`41`	`type RenderOpts struct {`
`42`		`- ColorMode checker.ColorMode`
	`42`	`+ ColorMode checker.ColorMode`
	`43`	`+ WrapInObject bool // wrap the output in a JSON object with the key "changes"`
`43`	`44`	`}`
`44`	`45`
`45`	`46`	`func NewRenderOpts() RenderOpts {`