Filepath select

inquire/Cargo.toml

@@ -23,6 +23,7 @@ default = ["macros", "crossterm", "editor"]
 macros = []
 date = ["chrono"]
 editor = ["tempfile"]
+path = ["fs-err", "humansize"]
 
 [package.metadata.docs.rs]
 all-features = true
@@ -37,6 +38,8 @@ chrono = { version = "0.4", optional = true }
 
 tempfile = { version = "3", optional = true }
 
+fs-err = { version = "2.9.0", optional = true }
+
 thiserror = "1"
 bitflags = "2"
 dyn-clone = "1"
@@ -45,6 +48,7 @@ newline-converter = "0.3"
 
 unicode-segmentation = "1"
 unicode-width = "0.1"
+humansize = { version = "2.1.3", optional = true, features = ["impl_style"] }
 
 [[example]]
 name = "form"
@@ -78,6 +82,10 @@ required-features = ["macros"]
 name = "password_full_featured"
 required-features = ["macros"]
 
+[[example]]
+name = "path_select"
+required-features = ["path"]
+
 [[example]]
 name = "manual_date_input"
 required-features = ["date"]

inquire/examples/path_select.rs

@@ -0,0 +1,46 @@
+//! Path picker example
+use inquire::{
+    PathFilter,
+    PathSelect,
+    PathSelectionMode,
+};
+
+fn main() {
+    let start_path = std::env::current_dir().expect("must get current dir");
+
+    let toml_extension = "toml";
+    let rs_extension = "rs";
+    let selection_mode = PathSelectionMode::File(
+        PathFilter::AcceptAny(vec![
+            PathFilter::AcceptExtension(toml_extension),
+            PathFilter::AcceptExtension(rs_extension),
+        ])
+    );
+
+    let ans = PathSelect::new(
+        &format!("pick an .{toml_extension} or .{rs_extension} file"),
+    )
+    .with_start_path(start_path)
+    .with_select_multiple(true)
+    .with_selection_mode(selection_mode)
+    .prompt();
+
+    match ans {
+        Ok(entries) => {
+            let l = entries.len();
+            println!(
+                "\nYou picked {l} items{}",
+                (!entries.is_empty())
+                    .then(|| {
+                        entries
+                            .iter()
+                            .enumerate()
+                            .map(|(i, entry)| format!("\n{i}: {entry}"))
+                            .collect::<String>()
+                    })
+                    .unwrap_or_default()
+            )
+        }
+        Err(err) => eprintln!("Your choices were wretched:\n{err:#?}"),
+    }
+}

inquire/src/prompts/mod.rs

@@ -7,6 +7,8 @@ mod dateselect;
 mod editor;
 mod multiselect;
 mod password;
+#[cfg(feature = "path")]
+mod path_select;
 mod prompt;
 mod select;
 mod text;
@@ -20,5 +22,7 @@ pub use dateselect::*;
 pub use editor::*;
 pub use multiselect::*;
 pub use password::*;
+#[cfg(feature = "path")]
+pub use path_select::*;
 pub use select::*;
 pub use text::*;

inquire/src/prompts/path_select/action.rs

@@ -0,0 +1,67 @@
+use crate::{
+    ui::{Key, KeyModifiers},
+    InnerAction, InputAction,
+};
+
+use super::config::PathSelectConfig;
+
+/// Set of actions for a MultiSelectPrompt.
+#[derive(Copy, Clone, Debug, PartialEq, Eq)]
+pub enum PathSelectPromptAction {
+    /// Action on the value text input handler.
+    FilterInput(InputAction),
+    /// Moves the cursor to the option above.
+    MoveUp,
+    /// Moves the cursor to the option below.
+    MoveDown,
+    /// Moves the cursor to the page above.
+    PageUp,
+    /// Moves the cursor to the page below.
+    PageDown,
+    /// Moves the cursor to the start of the list.
+    MoveToStart,
+    /// Moves the cursor to the end of the list.
+    MoveToEnd,
+    /// Toggles the selection of the current option.
+    ToggleCurrentOption,
+    /// Selects all options.
+    SelectAll,
+    /// Deselects all options.
+    ClearSelections,
+    /// Navigates deeper in file tree when current selection is a directory.
+    NavigateDeeper,
+    /// Navigates higher in file tree.
+    ///
+    /// No-op if on a root directory.
+    NavigateHigher,
+    /// Changes the [sorting mode](crate::PathSortingMode). 
+    ChangeSortMode,
+}
+
+impl InnerAction<PathSelectConfig> for PathSelectPromptAction {
+    fn from_key(key: Key, _config: &PathSelectConfig) -> Option<Self> {
+        let action = match key {
+            Key::Up(KeyModifiers::NONE) => Self::MoveUp,
+            Key::PageUp => Self::PageUp,
+            Key::Home => Self::MoveToStart,
+
+            Key::Down(KeyModifiers::NONE) => Self::MoveDown,
+            Key::PageDown => Self::PageDown,
+            Key::End => Self::MoveToEnd,
+
+            Key::Char(' ', KeyModifiers::NONE) => Self::ToggleCurrentOption,
+            Key::Right(KeyModifiers::SHIFT) => Self::SelectAll,
+            Key::Right(KeyModifiers::NONE) => Self::NavigateDeeper,
+            Key::Left(KeyModifiers::SHIFT) => Self::ClearSelections,
+            Key::Left(KeyModifiers::NONE) => Self::NavigateHigher,
+            Key::Tab => Self::ChangeSortMode,
+
+            key => match InputAction::from_key(key, &()) {
+                Some(action) => Self::FilterInput(action),
+                None => return None,
+            },
+        };
+
+        Some(action)
+    }
+}

inquire/src/prompts/path_select/config.rs

@@ -0,0 +1,20 @@
+use crate::PathSelect;
+
+/// Configuration settings used in the execution of a PathSelectPrompt.
+#[derive(Copy, Clone, Debug)]
+pub struct PathSelectConfig {
+    /// Page size of the list of options.
+    pub page_size: usize,
+    /// Whether to keep the filter text when an option is selected.
+    pub keep_filter: bool,
+}
+
+impl<T> From<&PathSelect<'_, T>> for PathSelectConfig {
+    fn from(value: &PathSelect<'_, T>) -> Self {
+        Self {
+            page_size: value.page_size,
+            keep_filter: value.keep_filter,
+        }
+    }
+}
+