feat(cli): add input-position cli argument (#840)

Author: alexpasmantier

docs/01-Users/09-cli.md

@@ -198,11 +198,16 @@ Input:
           The given value is used as the prompt string shown before the input field.
           Defaults to ">" when omitted.
 
+      --input-position <INPUT_POSITION>
+          Input bar position.
+          
+          Sets whether the input panel is shown at the top or bottom of the UI.
+          
+          [possible values: top, bottom]
+
       --input-border <INPUT_BORDER>
           Sets the input panel border type.
           
-          Available options are: `none`, `plain`, `rounded`, `thick`.
-          
           [possible values: none, plain, rounded, thick]
 
       --input-padding <STRING>
@@ -235,8 +240,6 @@ UI:
       --results-border <RESULTS_BORDER>
           Sets the results panel border type.
           
-          Available options are: `none`, `plain`, `rounded`, `thick`.
-          
           [possible values: none, plain, rounded, thick]
 
       --results-padding <STRING>
@@ -252,8 +255,6 @@ UI:
           When a channel is specified: Overrides the layout/orientation defined in the channel prototype.
           When no channel is specified: Sets the layout orientation for the ad-hoc channel.
           
-          Options are "landscape" or "portrait".
-          
           [possible values: landscape, portrait]
 
       --no-remote

man/tv.1

@@ -4,7 +4,7 @@
 .SH NAME
 television \- A very fast, portable and hackable fuzzy finder for the terminal
 .SH SYNOPSIS
-\fBtelevision\fR [\fB\-s\fR|\fB\-\-source\-command\fR] [\fB\-\-ansi\fR] [\fB\-\-source\-display\fR] [\fB\-\-source\-output\fR] [\fB\-\-source\-entry\-delimiter\fR] [\fB\-p\fR|\fB\-\-preview\-command\fR] [\fB\-\-preview\-header\fR] [\fB\-\-preview\-footer\fR] [\fB\-\-cache\-preview\fR] [\fB\-\-preview\-offset\fR] [\fB\-\-no\-preview\fR] [\fB\-\-hide\-preview\fR] [\fB\-\-show\-preview\fR] [\fB\-\-preview\-border\fR] [\fB\-\-preview\-padding\fR] [\fB\-\-hide\-preview\-scrollbar\fR] [\fB\-\-preview\-size\fR] [\fB\-i\fR|\fB\-\-input\fR] [\fB\-\-input\-header\fR] [\fB\-\-input\-prompt\fR] [\fB\-\-input\-border\fR] [\fB\-\-input\-padding\fR] [\fB\-\-no\-status\-bar\fR] [\fB\-\-hide\-status\-bar\fR] [\fB\-\-show\-status\-bar\fR] [\fB\-\-results\-border\fR] [\fB\-\-results\-padding\fR] [\fB\-\-layout\fR] [\fB\-\-no\-remote\fR] [\fB\-\-hide\-remote\fR] [\fB\-\-show\-remote\fR] [\fB\-\-no\-help\-panel\fR] [\fB\-\-hide\-help\-panel\fR] [\fB\-\-show\-help\-panel\fR] [\fB\-\-ui\-scale\fR] [\fB\-\-height\fR] [\fB\-\-width\fR] [\fB\-\-inline\fR] [\fB\-t\fR|\fB\-\-tick\-rate\fR] [\fB\-\-watch\fR] [\fB\-\-autocomplete\-prompt\fR] [\fB\-\-exact\fR] [\fB\-\-select\-1\fR] [\fB\-\-take\-1\fR] [\fB\-\-take\-1\-fast\fR] [\fB\-k\fR|\fB\-\-keybindings\fR] [\fB\-\-expect\fR] [\fB\-\-config\-file\fR] [\fB\-\-cable\-dir\fR] [\fB\-\-global\-history\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR] [\fICHANNEL\fR] [\fIPATH\fR] [\fIsubcommands\fR]
+\fBtelevision\fR [\fB\-s\fR|\fB\-\-source\-command\fR] [\fB\-\-ansi\fR] [\fB\-\-source\-display\fR] [\fB\-\-source\-output\fR] [\fB\-\-source\-entry\-delimiter\fR] [\fB\-p\fR|\fB\-\-preview\-command\fR] [\fB\-\-preview\-header\fR] [\fB\-\-preview\-footer\fR] [\fB\-\-cache\-preview\fR] [\fB\-\-preview\-offset\fR] [\fB\-\-no\-preview\fR] [\fB\-\-hide\-preview\fR] [\fB\-\-show\-preview\fR] [\fB\-\-preview\-border\fR] [\fB\-\-preview\-padding\fR] [\fB\-\-hide\-preview\-scrollbar\fR] [\fB\-\-preview\-size\fR] [\fB\-i\fR|\fB\-\-input\fR] [\fB\-\-input\-header\fR] [\fB\-\-input\-prompt\fR] [\fB\-\-input\-position\fR] [\fB\-\-input\-border\fR] [\fB\-\-input\-padding\fR] [\fB\-\-no\-status\-bar\fR] [\fB\-\-hide\-status\-bar\fR] [\fB\-\-show\-status\-bar\fR] [\fB\-\-results\-border\fR] [\fB\-\-results\-padding\fR] [\fB\-\-layout\fR] [\fB\-\-no\-remote\fR] [\fB\-\-hide\-remote\fR] [\fB\-\-show\-remote\fR] [\fB\-\-no\-help\-panel\fR] [\fB\-\-hide\-help\-panel\fR] [\fB\-\-show\-help\-panel\fR] [\fB\-\-ui\-scale\fR] [\fB\-\-height\fR] [\fB\-\-width\fR] [\fB\-\-inline\fR] [\fB\-t\fR|\fB\-\-tick\-rate\fR] [\fB\-\-watch\fR] [\fB\-\-autocomplete\-prompt\fR] [\fB\-\-exact\fR] [\fB\-\-select\-1\fR] [\fB\-\-take\-1\fR] [\fB\-\-take\-1\-fast\fR] [\fB\-k\fR|\fB\-\-keybindings\fR] [\fB\-\-expect\fR] [\fB\-\-config\-file\fR] [\fB\-\-cable\-dir\fR] [\fB\-\-global\-history\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR] [\fICHANNEL\fR] [\fIPATH\fR] [\fIsubcommands\fR]
 .SH DESCRIPTION
 A very fast, portable and hackable fuzzy finder for the terminal
 .SH OPTIONS
@@ -29,12 +29,7 @@ To pull the latest collection of channels from github, use the
 [\fIPATH\fR]
 The working directory to start the application in.
 
-This flag works identically in both channel mode and ad\-hoc mode.
-
-This can be used to specify a different working directory for the
-application to start in. This is useful when the application is
-started from a different directory than the one the user wants to
-interact with.
+Defaults to the current directory.
 .SH SOURCE
 .TP
 \fB\-s\fR, \fB\-\-source\-command\fR \fI<STRING>\fR
@@ -203,10 +198,17 @@ When no channel is specified: Sets the input prompt for the ad\-hoc channel.
 The given value is used as the prompt string shown before the input field.
 Defaults to ">" when omitted.
 .TP
+\fB\-\-input\-position\fR \fI<INPUT_POSITION>\fR
+Input bar position.
+
+Sets whether the input panel is shown at the top or bottom of the UI.
+.br
+
+.br
+[\fIpossible values: \fRtop, bottom]
+.TP
 \fB\-\-input\-border\fR \fI<INPUT_BORDER>\fR
 Sets the input panel border type.
-
-Available options are: `none`, `plain`, `rounded`, `thick`.
 .br
 
 .br
@@ -241,8 +243,6 @@ This overrides any channel configuration that might have it disabled.
 .TP
 \fB\-\-results\-border\fR \fI<RESULTS_BORDER>\fR
 Sets the results panel border type.
-
-Available options are: `none`, `plain`, `rounded`, `thick`.
 .br
 
 .br
@@ -260,8 +260,6 @@ Layout orientation for the UI.
 
 When a channel is specified: Overrides the layout/orientation defined in the channel prototype.
 When no channel is specified: Sets the layout orientation for the ad\-hoc channel.
-
-Options are "landscape" or "portrait".
 .br
 
 .br

television/cli/args.rs

@@ -291,9 +291,19 @@ pub struct Cli {
     )]
     pub input_prompt: Option<String>,
 
-    /// Sets the input panel border type.
+    /// Input bar position.
     ///
-    /// Available options are: `none`, `plain`, `rounded`, `thick`.
+    /// Sets whether the input panel is shown at the top or bottom of the UI.
+    #[arg(
+        long,
+        value_enum,
+        value_name = "INPUT_POSITION",
+        verbatim_doc_comment,
+        help_heading = "Input"
+    )]
+    pub input_position: Option<InputPosition>,
+
+    /// Sets the input panel border type.
     #[arg(long, value_enum, verbatim_doc_comment, help_heading = "Input")]
     pub input_border: Option<BorderType>,
 
@@ -333,8 +343,6 @@ pub struct Cli {
     pub show_status_bar: bool,
 
     /// Sets the results panel border type.
-    ///
-    /// Available options are: `none`, `plain`, `rounded`, `thick`.
     #[arg(long, value_enum, verbatim_doc_comment, help_heading = "UI")]
     pub results_border: Option<BorderType>,
 
@@ -355,8 +363,6 @@ pub struct Cli {
     ///
     /// When a channel is specified: Overrides the layout/orientation defined in the channel prototype.
     /// When no channel is specified: Sets the layout orientation for the ad-hoc channel.
-    ///
-    /// Options are "landscape" or "portrait".
     #[arg(long, value_enum, verbatim_doc_comment, help_heading = "UI")]
     pub layout: Option<LayoutOrientation>,
 
@@ -668,6 +674,12 @@ pub enum LayoutOrientation {
     Portrait,
 }
 
+#[derive(Debug, Clone, Copy, PartialEq, ValueEnum)]
+pub enum InputPosition {
+    Top,
+    Bottom,
+}
+
 #[derive(Debug, Clone, Copy, PartialEq, ValueEnum)]
 pub enum BorderType {
     None,

television/cli/mod.rs

@@ -9,7 +9,7 @@ use crate::{
     },
     errors::cli_parsing_error_exit,
     event::Key,
-    screen::layout::Orientation,
+    screen::layout::{InputPosition, Orientation},
     utils::paths::expand_tilde,
 };
 use anyhow::{Result, anyhow};
@@ -105,6 +105,7 @@ pub struct ChannelCli {
     pub input: Option<String>,
     pub input_header: Option<String>,
     pub input_prompt: Option<String>,
+    pub input_position: Option<InputPosition>,
     pub input_border: Option<BorderType>,
     pub input_padding: Option<Padding>,
 
@@ -280,6 +281,7 @@ pub fn post_process(cli: Cli, readable_stdin: bool) -> PostProcessedCli {
 
     // Determine layout
     let layout: Option<Orientation> = cli.layout.map(Orientation::from);
+    let input_position = cli.input_position.map(InputPosition::from);
 
     // borders
     let input_border = cli.input_border.map(BorderType::from);
@@ -347,6 +349,7 @@ pub fn post_process(cli: Cli, readable_stdin: bool) -> PostProcessedCli {
             input: cli.input,
             input_header: cli.input_header,
             input_prompt: cli.input_prompt,
+            input_position,
             input_border,
             input_padding,
 

television/config/layers.rs

@@ -202,12 +202,15 @@ impl ConfigLayers {
                 || self.base_config.ui.status_bar.separator_close.clone(),
                 |sb| sb.separator_close.clone(),
             );
-        let input_bar_position = self
-            .channel
-            .ui
-            .as_ref()
-            .and_then(|ui| ui.input_bar.as_ref())
-            .map_or(self.base_config.ui.input_bar.position, |ib| ib.position);
+        let input_bar_position = self.channel_cli.input_position.unwrap_or(
+            self.channel
+                .ui
+                .as_ref()
+                .and_then(|ui| ui.input_bar.as_ref())
+                .map_or(self.base_config.ui.input_bar.position, |ib| {
+                    ib.position
+                }),
+        );
 
         // CLI > channel > base config fields
         let ui_scale = self.channel_cli.ui_scale.unwrap_or(

television/screen/layout.rs

@@ -53,6 +53,15 @@ impl Display for InputPosition {
     }
 }
 
+impl From<crate::cli::args::InputPosition> for InputPosition {
+    fn from(value: crate::cli::args::InputPosition) -> Self {
+        match value {
+            crate::cli::args::InputPosition::Top => InputPosition::Top,
+            crate::cli::args::InputPosition::Bottom => InputPosition::Bottom,
+        }
+    }
+}
+
 #[derive(
     Debug,
     Clone,

tests/config/cli_overrides.rs

@@ -237,6 +237,41 @@ fn test_empty_cli_args_dont_override() {
     PtyTester::assert_exit_ok(&mut child, DEFAULT_DELAY);
 }
 
+/// Tests CLI override of input bar position
+#[test]
+fn test_cli_input_position_override() {
+    let mut tester = PtyTester::new();
+
+    let cmd = tv_with_args(&[
+        "files",
+        "--cable-dir",
+        DEFAULT_CABLE_DIR,
+        "--input-prompt",
+        "position-prompt>",
+        "--input-position",
+        "bottom",
+    ]);
+
+    let mut child = tester.spawn_command_tui(cmd);
+
+    let frame = tester.get_tui_frame();
+    let prompt_index = frame
+        .find("position-prompt>")
+        .expect("Expected input prompt in frame");
+    let results_index = frame
+        .find("Results")
+        .expect("Expected results header in frame");
+
+    assert!(
+        prompt_index > results_index,
+        "Expected input bar below results when using --input-position=bottom.\nFrame:\n{}",
+        frame
+    );
+
+    tester.send(&ctrl('c'));
+    PtyTester::assert_exit_ok(&mut child, DEFAULT_DELAY);
+}
+
 #[test]
 fn test_action_id_mismatch_validation_error() {
     let mut tester = PtyTester::new();