feat(command-panes): optionally allow panes to be closed on exit (#1869)

* feat(cli): allow option to close command pane on exit * feat(layouts): allow option to close command panes on exit * style(fmt): rustfmt
zellij-org · Oct 28, 2022 · c97b972 · c97b972
1 parent eed9541
commit c97b972
Show file tree

Hide file tree

Showing 10 changed files with 342 additions and 22 deletions.
diff --git a/src/main.rs b/src/main.rs
@@ -25,6 +25,7 @@ fn main() {
             cwd,
             floating,
             name,
+            close_on_exit,
         })) = opts.command
         {
             let command_cli_action = CliAction::NewPane {
@@ -33,6 +34,7 @@ fn main() {
                 cwd,
                 floating,
                 name,
+                close_on_exit,
             };
             commands::send_action_to_session(command_cli_action, opts.session);
             std::process::exit(0);

diff --git a/zellij-server/src/unit/screen_tests.rs b/zellij-server/src/unit/screen_tests.rs
@@ -1821,6 +1821,7 @@ pub fn send_cli_new_pane_action_with_default_parameters() {
         cwd: None,
         floating: false,
         name: None,
+        close_on_exit: false,
     };
     send_cli_action_to_server(
         &session_metadata,
@@ -1859,6 +1860,7 @@ pub fn send_cli_new_pane_action_with_split_direction() {
         cwd: None,
         floating: false,
         name: None,
+        close_on_exit: false,
     };
     send_cli_action_to_server(
         &session_metadata,
@@ -1897,6 +1899,7 @@ pub fn send_cli_new_pane_action_with_command_and_cwd() {
         cwd: Some("/some/folder".into()),
         floating: false,
         name: None,
+        close_on_exit: false,
     };
     send_cli_action_to_server(
         &session_metadata,

diff --git a/zellij-utils/src/cli.rs b/zellij-utils/src/cli.rs
@@ -146,6 +146,10 @@ pub enum Sessions {
         /// Name of the new pane
         #[clap(short, long, value_parser)]
         name: Option<String>,
+
+        /// Close the pane immediately when its command exits
+        #[clap(short, long, value_parser, default_value("false"), takes_value(false))]
+        close_on_exit: bool,
     },
     /// Edit file with default $EDITOR / $VISUAL
     #[clap(visible_alias = "e")]
@@ -246,6 +250,17 @@ pub enum CliAction {
         /// Name of the new pane
         #[clap(short, long, value_parser)]
         name: Option<String>,
+
+        /// Close the pane immediately when its command exits
+        #[clap(
+            short,
+            long,
+            value_parser,
+            default_value("false"),
+            takes_value(false),
+            requires("command")
+        )]
+        close_on_exit: bool,
     },
     /// Open the specified file in a new zellij pane with your default EDITOR
     Edit {

diff --git a/zellij-utils/src/input/actions.rs b/zellij-utils/src/input/actions.rs
@@ -258,17 +258,19 @@ impl Action {
                 cwd,
                 floating,
                 name,
+                close_on_exit,
             } => {
                 if !command.is_empty() {
                     let mut command = command.clone();
                     let (command, args) = (PathBuf::from(command.remove(0)), command);
                     let cwd = cwd.or_else(|| std::env::current_dir().ok());
+                    let hold_on_close = !close_on_exit;
                     let run_command_action = RunCommandAction {
                         command,
                         args,
                         cwd,
                         direction,
-                        hold_on_close: true,
+                        hold_on_close,
                     };
                     if floating {
                         Ok(vec![Action::NewFloatingPane(

diff --git a/zellij-utils/src/input/layout.rs b/zellij-utils/src/input/layout.rs
@@ -130,6 +130,26 @@ impl Run {
             _ => {}, // plugins aren't yet supported
         }
     }
+    pub fn add_args(&mut self, args: Option<Vec<String>>) {
+        // overrides the args of a Run::Command if they are Some
+        // and not empty
+        if let Some(args) = args {
+            if let Run::Command(run_command) = self {
+                if !args.is_empty() {
+                    run_command.args = args.clone();
+                }
+            }
+        }
+    }
+    pub fn add_close_on_exit(&mut self, close_on_exit: Option<bool>) {
+        // overrides the args of a Run::Command if they are Some
+        // and not empty
+        if let Some(close_on_exit) = close_on_exit {
+            if let Run::Command(run_command) = self {
+                run_command.hold_on_close = !close_on_exit;
+            }
+        }
+    }
 }
 
 #[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Eq)]

diff --git a/zellij-utils/src/input/unit/layout_test.rs b/zellij-utils/src/input/unit/layout_test.rs
@@ -268,6 +268,19 @@ fn layout_with_command_panes_and_cwd_and_args() {
     assert_eq!(layout, expected_layout);
 }
 
+#[test]
+fn layout_with_command_panes_and_close_on_exit() {
+    let kdl_layout = r#"
+        layout {
+            pane command="htop" {
+                close_on_exit true
+            }
+        }
+    "#;
+    let layout = Layout::from_kdl(kdl_layout, "layout_file_name".into(), None).unwrap();
+    assert_snapshot!(format!("{:#?}", layout));
+}
+
 #[test]
 fn layout_with_plugin_panes() {
     let kdl_layout = r#"
@@ -1033,6 +1046,24 @@ fn args_override_args_in_template() {
     assert_snapshot!(format!("{:#?}", layout));
 }
 
+#[test]
+fn close_on_exit_overrides_close_on_exit_in_template() {
+    let kdl_layout = r#"
+        layout {
+            pane_template name="tail" {
+                command "tail"
+                close_on_exit false
+            }
+            tail
+            tail {
+                close_on_exit true
+            }
+        }
+    "#;
+    let layout = Layout::from_kdl(kdl_layout, "layout_file_name".into(), None).unwrap();
+    assert_snapshot!(format!("{:#?}", layout));
+}
+
 #[test]
 fn args_added_to_args_in_template() {
     let kdl_layout = r#"
@@ -1050,6 +1081,23 @@ fn args_added_to_args_in_template() {
     assert_snapshot!(format!("{:#?}", layout));
 }
 
+#[test]
+fn close_on_exit_added_to_close_on_exit_in_template() {
+    let kdl_layout = r#"
+        layout {
+            pane_template name="tail" {
+                command "tail"
+            }
+            tail
+            tail {
+                close_on_exit true
+            }
+        }
+    "#;
+    let layout = Layout::from_kdl(kdl_layout, "layout_file_name".into(), None).unwrap();
+    assert_snapshot!(format!("{:#?}", layout));
+}
+
 #[test]
 fn cwd_override_cwd_in_template() {
     let kdl_layout = r#"
@@ -1125,6 +1173,19 @@ fn error_on_bare_args_without_command() {
     assert!(layout.is_err(), "error provided");
 }
 
+#[test]
+fn error_on_bare_close_on_exit_without_command() {
+    let kdl_layout = r#"
+        layout {
+            pane {
+                close_on_exit true
+            }
+        }
+    "#;
+    let layout = Layout::from_kdl(kdl_layout, "layout_file_name".into(), None);
+    assert!(layout.is_err(), "error provided");
+}
+
 #[test]
 fn error_on_bare_args_in_template_without_command() {
     let kdl_layout = r#"
@@ -1139,6 +1200,20 @@ fn error_on_bare_args_in_template_without_command() {
     assert!(layout.is_err(), "error provided");
 }
 
+#[test]
+fn error_on_bare_close_on_exit_in_template_without_command() {
+    let kdl_layout = r#"
+        layout {
+            pane_template name="my_template"
+            my_template {
+                close_on_exit true
+            }
+        }
+    "#;
+    let layout = Layout::from_kdl(kdl_layout, "layout_file_name".into(), None);
+    assert!(layout.is_err(), "error provided");
+}
+
 #[test]
 fn pane_template_command_with_cwd_overriden_by_its_consumers_command_cwd() {
     let kdl_layout = r#"

diff --git a/..._utils__input__layout__layout_test__close_on_exit_added_to_close_on_exit_in_template.snap b/..._utils__input__layout__layout_test__close_on_exit_added_to_close_on_exit_in_template.snap
@@ -0,0 +1,60 @@
+---
+source: zellij-utils/src/input/./unit/layout_test.rs
+assertion_line: 1098
+expression: "format!(\"{:#?}\", layout)"
+---
+Layout {
+    tabs: [],
+    focused_tab_index: None,
+    template: Some(
+        PaneLayout {
+            children_split_direction: Horizontal,
+            name: None,
+            children: [
+                PaneLayout {
+                    children_split_direction: Horizontal,
+                    name: None,
+                    children: [],
+                    split_size: None,
+                    run: Some(
+                        Command(
+                            RunCommand {
+                                command: "tail",
+                                args: [],
+                                cwd: None,
+                                hold_on_close: true,
+                            },
+                        ),
+                    ),
+                    borderless: false,
+                    focus: None,
+                    external_children_index: None,
+                },
+                PaneLayout {
+                    children_split_direction: Horizontal,
+                    name: None,
+                    children: [],
+                    split_size: None,
+                    run: Some(
+                        Command(
+                            RunCommand {
+                                command: "tail",
+                                args: [],
+                                cwd: None,
+                                hold_on_close: false,
+                            },
+                        ),
+                    ),
+                    borderless: false,
+                    focus: None,
+                    external_children_index: None,
+                },
+            ],
+            split_size: None,
+            run: None,
+            borderless: false,
+            focus: None,
+            external_children_index: None,
+        },
+    ),
+}
diff --git a/...utils__input__layout__layout_test__close_on_exit_overrides_close_on_exit_in_template.snap b/...utils__input__layout__layout_test__close_on_exit_overrides_close_on_exit_in_template.snap
@@ -0,0 +1,60 @@
+---
+source: zellij-utils/src/input/./unit/layout_test.rs
+assertion_line: 1064
+expression: "format!(\"{:#?}\", layout)"
+---
+Layout {
+    tabs: [],
+    focused_tab_index: None,
+    template: Some(
+        PaneLayout {
+            children_split_direction: Horizontal,
+            name: None,
+            children: [
+                PaneLayout {
+                    children_split_direction: Horizontal,
+                    name: None,
+                    children: [],
+                    split_size: None,
+                    run: Some(
+                        Command(
+                            RunCommand {
+                                command: "tail",
+                                args: [],
+                                cwd: None,
+                                hold_on_close: true,
+                            },
+                        ),
+                    ),
+                    borderless: false,
+                    focus: None,
+                    external_children_index: None,
+                },
+                PaneLayout {
+                    children_split_direction: Horizontal,
+                    name: None,
+                    children: [],
+                    split_size: None,
+                    run: Some(
+                        Command(
+                            RunCommand {
+                                command: "tail",
+                                args: [],
+                                cwd: None,
+                                hold_on_close: false,
+                            },
+                        ),
+                    ),
+                    borderless: false,
+                    focus: None,
+                    external_children_index: None,
+                },
+            ],
+            split_size: None,
+            run: None,
+            borderless: false,
+            focus: None,
+            external_children_index: None,
+        },
+    ),
+}
diff --git a/...ellij_utils__input__layout__layout_test__layout_with_command_panes_and_close_on_exit.snap b/...ellij_utils__input__layout__layout_test__layout_with_command_panes_and_close_on_exit.snap
@@ -0,0 +1,41 @@
+---
+source: zellij-utils/src/input/./unit/layout_test.rs
+assertion_line: 281
+expression: "format!(\"{:#?}\", layout)"
+---
+Layout {
+    tabs: [],
+    focused_tab_index: None,
+    template: Some(
+        PaneLayout {
+            children_split_direction: Horizontal,
+            name: None,
+            children: [
+                PaneLayout {
+                    children_split_direction: Horizontal,
+                    name: None,
+                    children: [],
+                    split_size: None,
+                    run: Some(
+                        Command(
+                            RunCommand {
+                                command: "htop",
+                                args: [],
+                                cwd: None,
+                                hold_on_close: false,
+                            },
+                        ),
+                    ),
+                    borderless: false,
+                    focus: None,
+                    external_children_index: None,
+                },
+            ],
+            split_size: None,
+            run: None,
+            borderless: false,
+            focus: None,
+            external_children_index: None,
+        },
+    ),
+}