Combine customCommand's stream and showOutput fields into a single output enum

It doesn't make sense to set both to true, so combine them into one property.

Author: stefanhaller

docs/Custom_Command_Keybindings.md

@@ -57,10 +57,9 @@ For a given custom command, here are the allowed fields:
 | prompts | A list of prompts that will request user input before running the final command | no |
 | loadingText | Text to display while waiting for command to finish | no |
 | description | Label for the custom command when displayed in the keybindings menu | no |
-| stream | Whether you want to stream the command's output to the Command Log panel | no |
-| pty | Whether you want to run the command in a pseudo terminal (pty). This can be useful for commands that produce colored output when the output is a terminal. Only used when `stream` is also true. Use with care: some commands may expect the terminal to have capabilities that lazygit's pty doesn't. | no |
-| showOutput | Whether you want to show the command's output in a popup within Lazygit | no |
-| outputTitle | The title to display in the popup panel if showOutput is true. If left unset, the command will be used as the title. | no |
+| output | Where the output of the command should go. 'none' discards it, 'log' shows it in the command log, and 'popup' shows it in a popup. | no |
+| pty | Whether you want to run the command in a pseudo terminal (pty). This can be useful for commands that produce colored output when the output is a terminal. Only used when ouput is set to 'log', and subprocess is false. Use with care: some commands may expect the terminal to have capabilities that lazygit's pty doesn't. | no |
+| outputTitle | The title to display in the popup panel if output is set to 'popup'. If left unset, the command will be used as the title. | no |
 | after | Actions to take after the command has completed | no |
 
 Here are the options for the `after` key:
@@ -366,7 +365,7 @@ If you use the commandMenu property, none of the other properties except key and
 
 ## Debugging
 
-If you want to verify that your command actually does what you expect, you can wrap it in an 'echo' call and set `showOutput: true` so that it doesn't actually execute the command but you can see how the placeholders were resolved.
+If you want to verify that your command actually does what you expect, you can wrap it in an 'echo' call and set `output: popup` so that it doesn't actually execute the command but you can see how the placeholders were resolved.
 
 ## More Examples
 

pkg/config/app_config.go

@@ -281,6 +281,11 @@ func computeMigratedConfig(path string, content []byte) ([]byte, error) {
 		return nil, fmt.Errorf("Couldn't migrate config file at `%s`: %s", path, err)
 	}
 
+	err = changeCustomCommandStreamAndOutputToOutputEnum(&rootNode)
+	if err != nil {
+		return nil, fmt.Errorf("Couldn't migrate config file at `%s`: %s", path, err)
+	}
+
 	// Add more migrations here...
 
 	if !reflect.DeepEqual(rootNode, originalCopy) {
@@ -341,6 +346,41 @@ func changeCommitPrefixesMap(rootNode *yaml.Node) error {
 	})
 }
 
+func changeCustomCommandStreamAndOutputToOutputEnum(rootNode *yaml.Node) error {
+	return yaml_utils.Walk(rootNode, func(node *yaml.Node, path string) {
+		// We are being lazy here and rely on the fact that the only mapping
+		// nodes in the tree under customCommands are actual custom commands. If
+		// this ever changes (e.g. because we add a struct field to
+		// customCommand), then we need to change this to iterate properly.
+		if strings.HasPrefix(path, "customCommands[") && node.Kind == yaml.MappingNode {
+			output := ""
+			if streamKey, streamValue := yaml_utils.RemoveKey(node, "stream"); streamKey != nil {
+				if streamValue.Kind == yaml.ScalarNode && streamValue.Value == "true" {
+					output = "log"
+				}
+			}
+			if streamKey, streamValue := yaml_utils.RemoveKey(node, "showOutput"); streamKey != nil {
+				if streamValue.Kind == yaml.ScalarNode && streamValue.Value == "true" && output == "" {
+					output = "popup"
+				}
+			}
+			if output != "" {
+				outputKeyNode := &yaml.Node{
+					Kind:  yaml.ScalarNode,
+					Value: "output",
+					Tag:   "!!str",
+				}
+				outputValueNode := &yaml.Node{
+					Kind:  yaml.ScalarNode,
+					Value: output,
+					Tag:   "!!str",
+				}
+				node.Content = append(node.Content, outputKeyNode, outputValueNode)
+			}
+		}
+	})
+}
+
 func (c *AppConfig) GetDebug() bool {
 	return c.debug
 }

pkg/config/user_config.go

@@ -646,17 +646,14 @@ type CustomCommand struct {
 	LoadingText string `yaml:"loadingText" jsonschema:"example=Loading..."`
 	// Label for the custom command when displayed in the keybindings menu
 	Description string `yaml:"description"`
-	// If true, stream the command's output to the Command Log panel
-	// [dev] Pointer to bool so that we can distinguish unset (nil) from false.
-	Stream *bool `yaml:"stream"`
-	// If true, show the command's output in a popup within Lazygit
-	// [dev] Pointer to bool so that we can distinguish unset (nil) from false.
-	ShowOutput *bool `yaml:"showOutput"`
+	// Where the output of the command should go. 'none' discards it, 'log' shows it in the command log, and 'popup' shows it in a popup.
+	// [dev] Pointer so that we can tell whether it appears in the config file
+	Output *string `yaml:"output" jsonschema:"enum=none,enum=log,enum=popup"`
 	// If true, run the command in a pseudo-terminal (pty). This can be useful for commands that produce colored output when the output is a terminal.
-	// Only used when stream is also true.
+	// Only used when ouput is set to 'log', and subprocess is false.
 	// Use with care: some commands may expect the terminal to have capabilities that lazygit's pty doesn't.
 	Pty *bool `yaml:"pty"`
-	// The title to display in the popup panel if showOutput is true. If left unset, the command will be used as the title.
+	// The title to display in the popup panel if output is set to 'popup'. If left unset, the command will be used as the title.
 	OutputTitle string `yaml:"outputTitle"`
 	// Actions to take after the command has completed
 	// [dev] Pointer so that we can tell whether it appears in the config file

pkg/config/user_config_validation.go

@@ -107,8 +107,7 @@ func validateCustomCommands(customCommands []CustomCommand) error {
 				customCommand.Subprocess != nil ||
 				len(customCommand.Prompts) > 0 ||
 				len(customCommand.LoadingText) > 0 ||
-				customCommand.Stream != nil ||
-				customCommand.ShowOutput != nil ||
+				customCommand.Output != nil ||
 				customCommand.Pty != nil ||
 				len(customCommand.OutputTitle) > 0 ||
 				customCommand.After != nil) {
@@ -119,6 +118,13 @@ func validateCustomCommands(customCommands []CustomCommand) error {
 			return fmt.Errorf("Error with custom command%s: it is not allowed to use both commandMenu and any of the other fields except key and description.", commandRef)
 		}
 
+		if customCommand.Output != nil {
+			if err := validateEnum("customCommand.output", *customCommand.Output,
+				[]string{"none", "log", "popup"}); err != nil {
+				return err
+			}
+		}
+
 		if err := validateCustomCommands(customCommand.CommandMenu); err != nil {
 			return err
 		}

pkg/config/user_config_validation_test.go

@@ -95,6 +95,23 @@ func TestUserConfigValidate_enums(t *testing.T) {
 				{value: "invalid_value", valid: false},
 			},
 		},
+		{
+			name: "Custom command output",
+			setup: func(config *UserConfig, value string) {
+				config.CustomCommands = []CustomCommand{
+					{
+						Output: &value,
+					},
+				}
+			},
+			testCases: []testCase{
+				{value: "none", valid: true},
+				{value: "log", valid: true},
+				{value: "popup", valid: true},
+				{value: "", valid: false},
+				{value: "invalid_value", valid: false},
+			},
+		},
 		{
 			name: "Custom command sub menu",
 			setup: func(config *UserConfig, _ string) {

pkg/gui/services/custom_commands/handler_creator.go

@@ -274,7 +274,7 @@ func (self *HandlerCreator) finalHandler(customCommand config.CustomCommand, ses
 	return self.c.WithWaitingStatus(loadingText, func(gocui.Task) error {
 		self.c.LogAction(self.c.Tr.Actions.CustomCommand)
 
-		if customCommand.Stream != nil && *customCommand.Stream {
+		if customCommand.Output != nil && *customCommand.Output == "log" {
 			cmdObj.StreamOutput()
 		}
 		if customCommand.Pty != nil && *customCommand.Pty {
@@ -294,7 +294,7 @@ func (self *HandlerCreator) finalHandler(customCommand config.CustomCommand, ses
 			return err
 		}
 
-		if customCommand.ShowOutput != nil && *customCommand.ShowOutput {
+		if customCommand.Output != nil && *customCommand.Output == "popup" {
 			if strings.TrimSpace(output) == "" {
 				output = self.c.Tr.EmptyOutput
 			}

pkg/integration/tests/custom_commands/show_output_in_panel.go

@@ -15,19 +15,19 @@ var ShowOutputInPanel = NewIntegrationTest(NewIntegrationTestArgs{
 		shell.EmptyCommit("my change")
 	},
 	SetupConfig: func(cfg *config.AppConfig) {
-		trueVal := true
+		popupVal := "popup"
 		cfg.GetUserConfig().CustomCommands = []config.CustomCommand{
 			{
-				Key:        "X",
-				Context:    "commits",
-				Command:    "printf '%s' '{{ .SelectedLocalCommit.Name }}'",
-				ShowOutput: &trueVal,
+				Key:     "X",
+				Context: "commits",
+				Command: "printf '%s' '{{ .SelectedLocalCommit.Name }}'",
+				Output:  &popupVal,
 			},
 			{
 				Key:         "Y",
 				Context:     "commits",
 				Command:     "printf '%s' '{{ .SelectedLocalCommit.Name }}'",
-				ShowOutput:  &trueVal,
+				Output:      &popupVal,
 				OutputTitle: "Subject of commit {{ .SelectedLocalCommit.Hash }}",
 			},
 		}

schema/config.json

@@ -118,21 +118,22 @@
           "type": "string",
           "description": "Label for the custom command when displayed in the keybindings menu"
         },
-        "stream": {
-          "type": "boolean",
-          "description": "If true, stream the command's output to the Command Log panel"
-        },
-        "showOutput": {
-          "type": "boolean",
-          "description": "If true, show the command's output in a popup within Lazygit"
+        "output": {
+          "type": "string",
+          "enum": [
+            "none",
+            "log",
+            "popup"
+          ],
+          "description": "Where the output of the command should go. 'none' discards it, 'log' shows it in the command log, and 'popup' shows it in a popup."
         },
         "pty": {
           "type": "boolean",
-          "description": "If true, run the command in a pseudo-terminal (pty). This can be useful for commands that produce colored output when the output is a terminal.\nOnly used when stream is also true.\nUse with care: some commands may expect the terminal to have capabilities that lazygit's pty doesn't."
+          "description": "If true, run the command in a pseudo-terminal (pty). This can be useful for commands that produce colored output when the output is a terminal.\nOnly used when ouput is set to 'log', and subprocess is false.\nUse with care: some commands may expect the terminal to have capabilities that lazygit's pty doesn't."
         },
         "outputTitle": {
           "type": "string",
-          "description": "The title to display in the popup panel if showOutput is true. If left unset, the command will be used as the title."
+          "description": "The title to display in the popup panel if output is set to 'popup'. If left unset, the command will be used as the title."
         },
         "after": {
           "$ref": "#/$defs/CustomCommandAfterHook",