cli/command/container: deprecate NewDiffFormat

thaJeztah · thaJeztah · commit 907507e22ade · 2025-07-16T13:45:05.000+02:00
It's part of the presentation logic of the cli, and only used internally.
We can consider providing utilities for these, but better as part of
separate packages.

Signed-off-by: Sebastiaan van Stijn &lt;github@gone.nl&gt;
diff --git a/cli/command/container/diff.go b/cli/command/container/diff.go
@@ -33,7 +33,7 @@ func runDiff(ctx context.Context, dockerCLI command.Cli, containerID string) err
 	}
 	diffCtx := formatter.Context{
 		Output: dockerCLI.Out(),
-		Format: NewDiffFormat("{{.Type}} {{.Path}}"),
+		Format: newDiffFormat("{{.Type}} {{.Path}}"),
 	}
 	return DiffFormatWrite(diffCtx, changes)
 }
diff --git a/cli/command/container/formatter_diff.go b/cli/command/container/formatter_diff.go
@@ -13,7 +13,14 @@ const (
 )
 
 // NewDiffFormat returns a format for use with a diff Context
+//
+// Deprecated: this function was only used internally and will be removed in the next release.
 func NewDiffFormat(source string) formatter.Format {
+	return newDiffFormat(source)
+}
+
+// newDiffFormat returns a format for use with a diff [formatter.Context].
+func newDiffFormat(source string) formatter.Format {
 	if source == formatter.TableFormatKey {
 		return defaultDiffTableFormat
 	}
diff --git a/cli/command/container/formatter_diff_test.go b/cli/command/container/formatter_diff_test.go
@@ -16,23 +16,23 @@ func TestDiffContextFormatWrite(t *testing.T) {
 		expected string
 	}{
 		{
-			formatter.Context{Format: NewDiffFormat("table")},
+			formatter.Context{Format: newDiffFormat("table")},
 			`CHANGE TYPE   PATH
 C             /var/log/app.log
 A             /usr/app/app.js
 D             /usr/app/old_app.js
 `,
 		},
 		{
-			formatter.Context{Format: NewDiffFormat("table {{.Path}}")},
+			formatter.Context{Format: newDiffFormat("table {{.Path}}")},
 			`PATH
 /var/log/app.log
 /usr/app/app.js
 /usr/app/old_app.js
 `,
 		},
 		{
-			formatter.Context{Format: NewDiffFormat("{{.Type}}: {{.Path}}")},
+			formatter.Context{Format: newDiffFormat("{{.Type}}: {{.Path}}")},
 			`C: /var/log/app.log
 A: /usr/app/app.js
 D: /usr/app/old_app.js

Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ func runDiff(ctx context.Context, dockerCLI command.Cli, containerID string) err`
`33`	`33`	`}`
`34`	`34`	`diffCtx := formatter.Context{`
`35`	`35`	`Output: dockerCLI.Out(),`
`36`		`- Format: NewDiffFormat("{{.Type}} {{.Path}}"),`
	`36`	`+ Format: newDiffFormat("{{.Type}} {{.Path}}"),`
`37`	`37`	`}`
`38`	`38`	`return DiffFormatWrite(diffCtx, changes)`
`39`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,14 @@ const (`
`13`	`13`	`)`
`14`	`14`
`15`	`15`	`// NewDiffFormat returns a format for use with a diff Context`
	`16`	`+//`
	`17`	`+// Deprecated: this function was only used internally and will be removed in the next release.`
`16`	`18`	`func NewDiffFormat(source string) formatter.Format {`
	`19`	`+ return newDiffFormat(source)`
	`20`	`+}`
	`21`	`+`
	`22`	`+// newDiffFormat returns a format for use with a diff [formatter.Context].`
	`23`	`+func newDiffFormat(source string) formatter.Format {`
`17`	`24`	`if source == formatter.TableFormatKey {`
`18`	`25`	`return defaultDiffTableFormat`
`19`	`26`	`}`