Merge pull request #384 from chris-crone/formatter-flag

Rename render presenter flag to formatter

Author: shin-

cmd/docker-app/render.go

@@ -69,6 +69,6 @@ func renderCmd(dockerCli command.Cli) *cobra.Command {
 	cmd.Flags().StringArrayVarP(&renderSettingsFile, "settings-files", "f", []string{}, "Override settings files")
 	cmd.Flags().StringArrayVarP(&renderEnv, "set", "s", []string{}, "Override settings values")
 	cmd.Flags().StringVarP(&renderOutput, "output", "o", "-", "Output file")
-	cmd.Flags().StringVarP(&formatDriver, "presenter", "p", "yaml", "Configure the output format (yaml|json)")
+	cmd.Flags().StringVar(&formatDriver, "formatter", "yaml", "Configure the output format (yaml|json)")
 	return cmd
 }

e2e/commands_test.go

@@ -78,10 +78,10 @@ func testRenderApp(appPath string, env ...string) func(*testing.T) {
 
 func TestRenderFormatters(t *testing.T) {
 	appPath := filepath.Join("testdata", "fork", "simple.dockerapp")
-	result := icmd.RunCommand(dockerApp, "render", "-p", "json", appPath).Assert(t, icmd.Success)
+	result := icmd.RunCommand(dockerApp, "render", "--formatter", "json", appPath).Assert(t, icmd.Success)
 	assert.Assert(t, golden.String(result.Stdout(), "expected-json-render.golden"))
 
-	result = icmd.RunCommand(dockerApp, "render", "-p", "yaml", appPath).Assert(t, icmd.Success)
+	result = icmd.RunCommand(dockerApp, "render", "--formatter", "yaml", appPath).Assert(t, icmd.Success)
 	assert.Assert(t, golden.String(result.Stdout(), "expected-yaml-render.golden"))
 }
 

internal/formatter/formatter.go

@@ -33,10 +33,10 @@ func Register(name string, driver driver.Driver) {
 // If the formatter is not registered, this errors out.
 func Format(config *composetypes.Config, formatter string) (string, error) {
 	driversMu.RLock()
-	d, present := drivers[formatter]
+	d, ok := drivers[formatter]
 	driversMu.RUnlock()
-	if !present {
-		return "", errors.Errorf("unknown presenter %q", formatter)
+	if !ok {
+		return "", errors.Errorf("unknown formatter %q", formatter)
 	}
 	s, err := d.Format(config)
 	if err != nil {

internal/formatter/formatter_test.go

@@ -64,7 +64,7 @@ func TestRegisteredDrivers(t *testing.T) {
 func TestFormatNonExistentDriver(t *testing.T) {
 	_, err := Format(&composetypes.Config{}, "toto")
 	assert.Check(t, err != nil)
-	assert.Check(t, is.ErrorContains(err, `unknown presenter "toto"`))
+	assert.Check(t, is.ErrorContains(err, `unknown formatter "toto"`))
 }
 
 func TestFormatErrorDriver(t *testing.T) {
@@ -80,7 +80,7 @@ func TestFormatNone(t *testing.T) {
 	defer resetDrivers()
 	_, err := Format(&composetypes.Config{}, "none")
 	assert.Check(t, err != nil)
-	assert.Check(t, is.ErrorContains(err, `unknown presenter "none"`))
+	assert.Check(t, is.ErrorContains(err, `unknown formatter "none"`))
 }
 
 func TestFormat(t *testing.T) {