wisp/components/
file_picker.rs

1use ignore::WalkBuilder;
2use std::env::current_dir;
3use std::path::{Path, PathBuf};
4use tui::{Combobox, Component, Event, Frame, Line, PickerMessage, Searchable, ViewContext};
5
6const MAX_INDEXED_FILES: usize = 50_000;
7
8#[doc = include_str!("../docs/file_picker.md")]
9pub struct FilePicker {
10    combobox: Combobox<FileMatch>,
11}
12
13pub type FilePickerMessage = PickerMessage<FileMatch>;
14
15#[derive(Debug, Clone)]
16pub struct FileMatch {
17    pub path: PathBuf,
18    pub display_name: String,
19}
20
21impl Searchable for FileMatch {
22    fn search_text(&self) -> String {
23        self.display_name.clone()
24    }
25}
26
27impl FilePicker {
28    pub fn new() -> Self {
29        let root = current_dir().unwrap_or_else(|_| PathBuf::from("."));
30        let mut entries = Vec::new();
31
32        let walker = WalkBuilder::new(&root)
33            .git_ignore(true)
34            .git_global(true)
35            .git_exclude(true)
36            .hidden(false)
37            .parents(true)
38            .build();
39
40        for entry in walker.flatten().take(MAX_INDEXED_FILES) {
41            let path = entry.path();
42            if !entry.file_type().is_some_and(|ft| ft.is_file()) || should_exclude_path(path) {
43                continue;
44            }
45
46            let display_name = path.strip_prefix(&root).unwrap_or(path).to_string_lossy().replace('\\', "/");
47
48            entries.push(FileMatch { path: path.to_path_buf(), display_name });
49        }
50
51        entries.sort_by(|a, b| a.display_name.cmp(&b.display_name));
52
53        Self { combobox: Combobox::new(entries) }
54    }
55
56    pub fn query(&self) -> &str {
57        self.combobox.query()
58    }
59
60    pub fn new_with_entries(entries: Vec<FileMatch>) -> Self {
61        Self { combobox: Combobox::new(entries) }
62    }
63}
64
65impl Default for FilePicker {
66    fn default() -> Self {
67        Self::new()
68    }
69}
70
71fn should_exclude_path(path: &Path) -> bool {
72    path.components().any(|component| {
73        let value = component.as_os_str().to_string_lossy();
74        value.starts_with('.') || matches!(value.as_ref(), "node_modules" | "target")
75    })
76}
77
78impl Component for FilePicker {
79    type Message = FilePickerMessage;
80
81    async fn on_event(&mut self, event: &Event) -> Option<Vec<Self::Message>> {
82        self.combobox.handle_picker_event(event)
83    }
84
85    fn render(&mut self, context: &ViewContext) -> Frame {
86        let mut lines = Vec::new();
87
88        if self.combobox.is_empty() {
89            lines.push(Line::new("  (no matches found)".to_string()));
90            return Frame::new(lines);
91        }
92
93        let item_lines = self.combobox.render_items(context, |file, is_selected, ctx| {
94            let line_text = file.display_name.clone();
95            if is_selected {
96                let mut line = Line::with_style(line_text, ctx.theme.selected_row_style());
97                line.extend_bg_to_width(ctx.size.width as usize);
98                line
99            } else {
100                Line::new(line_text)
101            }
102        });
103        lines.extend(item_lines);
104
105        Frame::new(lines)
106    }
107}
108
109#[cfg(test)]
110mod tests {
111    use super::*;
112    use tui::ViewContext;
113    use tui::test_picker::{rendered_lines_from, rendered_raw_lines_with_context, type_query};
114    use tui::{KeyCode, KeyEvent, KeyModifiers};
115
116    const DEFAULT_SIZE: (u16, u16) = (120, 40);
117
118    fn key(code: KeyCode) -> KeyEvent {
119        KeyEvent::new(code, KeyModifiers::NONE)
120    }
121
122    fn file_match(path: &str) -> FileMatch {
123        FileMatch { path: PathBuf::from(path), display_name: path.to_string() }
124    }
125
126    fn selected_text(picker: &mut FilePicker) -> Option<String> {
127        let context = ViewContext::new(DEFAULT_SIZE);
128        let frame = picker.render(&context);
129        frame.lines().iter().find(|line| line.plain_text().starts_with("  ")).map(tui::Line::plain_text)
130    }
131
132    #[test]
133    fn excludes_hidden_and_build_paths() {
134        assert!(should_exclude_path(Path::new(".git/config")));
135        assert!(should_exclude_path(Path::new("node_modules/react/index.js")));
136        assert!(should_exclude_path(Path::new("target/debug/wisp")));
137        assert!(should_exclude_path(Path::new("src/.cache/file.txt")));
138        assert!(!should_exclude_path(Path::new("src/main.rs")));
139    }
140
141    #[tokio::test]
142    async fn query_filters_matches() {
143        let mut picker = FilePicker::new_with_entries(vec![
144            file_match("src/main.rs"),
145            file_match("src/renderer.rs"),
146            file_match("README.md"),
147        ]);
148
149        type_query(&mut picker, "rend").await;
150
151        let lines = rendered_lines_from(&picker.render(&ViewContext::new(DEFAULT_SIZE)));
152        assert_eq!(lines.len(), 1);
153        assert!(lines[0].contains("src/renderer.rs"));
154    }
155
156    #[tokio::test]
157    async fn selection_wraps() {
158        let mut picker = FilePicker::new_with_entries(vec![file_match("a.rs"), file_match("b.rs"), file_match("c.rs")]);
159
160        let first = selected_text(&mut picker).unwrap();
161
162        picker.on_event(&Event::Key(key(KeyCode::Up))).await;
163        let last = selected_text(&mut picker).unwrap();
164        assert_ne!(first, last);
165
166        picker.on_event(&Event::Key(key(KeyCode::Down))).await;
167        let back_to_first = selected_text(&mut picker).unwrap();
168        assert_eq!(first, back_to_first);
169    }
170
171    #[test]
172    fn selected_entry_has_highlight_background() {
173        let mut picker = FilePicker::new_with_entries(vec![file_match("a.rs"), file_match("b.rs"), file_match("c.rs")]);
174        let context = ViewContext::new((80, 24));
175        let frame = picker.render(&context);
176        let selected_line = frame
177            .lines()
178            .iter()
179            .find(|line| line.plain_text().starts_with("  "))
180            .expect("should render a selected line");
181
182        let has_bg = selected_line.spans().iter().any(|span| span.style().bg == Some(context.theme.highlight_bg()));
183        assert!(has_bg, "selected entry should have highlight background");
184    }
185
186    #[test]
187    fn selected_entry_has_text_primary_foreground() {
188        let mut picker = FilePicker::new_with_entries(vec![file_match("a.rs")]);
189        let context = ViewContext::new((80, 24));
190        let lines = rendered_raw_lines_with_context(|ctx| picker.render(ctx), (80, 24));
191        let selected_line =
192            lines.iter().find(|line| line.plain_text().starts_with("  ")).expect("should render a selected line");
193
194        let has_fg = selected_line.spans().iter().any(|span| span.style().fg == Some(context.theme.text_primary()));
195        assert!(has_fg, "selected entry should have text_primary foreground");
196    }
197
198    #[test]
199    fn selected_entry_highlight_fills_full_line_width() {
200        let mut picker = FilePicker::new_with_entries(vec![file_match("a.rs")]);
201        let context = ViewContext::new((20, 24));
202        let lines = rendered_raw_lines_with_context(|ctx| picker.render(ctx), (20, 24));
203        let selected_line =
204            lines.iter().find(|line| line.plain_text().starts_with("  ")).expect("should render a selected line");
205
206        assert_eq!(
207            selected_line.display_width(),
208            context.size.width as usize,
209            "selected row should fill the full visible width",
210        );
211    }
212
213    #[tokio::test]
214    async fn handle_key_char_updates_query_and_returns_char_typed() {
215        let mut picker = FilePicker::new_with_entries(vec![file_match("src/renderer.rs")]);
216
217        let outcome = picker.on_event(&Event::Key(key(KeyCode::Char('r')))).await;
218
219        assert!(outcome.is_some());
220
221        assert!(matches!(outcome.unwrap().as_slice(), [PickerMessage::CharTyped('r')]));
222        assert_eq!(picker.query(), "r");
223    }
224
225    #[tokio::test]
226    async fn handle_key_whitespace_closes_picker() {
227        let mut picker = FilePicker::new_with_entries(vec![file_match("src/main.rs")]);
228
229        let outcome = picker.on_event(&Event::Key(key(KeyCode::Char(' ')))).await;
230
231        assert!(outcome.is_some());
232
233        assert!(matches!(outcome.unwrap().as_slice(), [PickerMessage::CloseWithChar(' ')]));
234    }
235
236    #[tokio::test]
237    async fn handle_key_enter_requests_confirmation() {
238        let mut picker = FilePicker::new_with_entries(vec![file_match("src/main.rs")]);
239
240        let outcome = picker.on_event(&Event::Key(key(KeyCode::Enter))).await;
241
242        assert!(outcome.is_some());
243
244        assert!(matches!(outcome.unwrap().as_slice(), [PickerMessage::Confirm(_)]));
245    }
246
247    #[tokio::test]
248    async fn backspace_with_empty_query_closes_and_pops() {
249        let mut picker = FilePicker::new_with_entries(vec![file_match("src/main.rs")]);
250
251        let outcome = picker.on_event(&Event::Key(key(KeyCode::Backspace))).await;
252
253        assert!(outcome.is_some());
254
255        assert!(matches!(outcome.unwrap().as_slice(), [PickerMessage::CloseAndPopChar]));
256    }
257
258    #[tokio::test]
259    async fn backspace_with_query_pops_char() {
260        let mut picker = FilePicker::new_with_entries(vec![file_match("src/main.rs")]);
261        type_query(&mut picker, "ma").await;
262
263        let outcome = picker.on_event(&Event::Key(key(KeyCode::Backspace))).await;
264
265        assert!(outcome.is_some());
266
267        assert!(matches!(outcome.unwrap().as_slice(), [PickerMessage::PopChar]));
268        assert_eq!(picker.query(), "m");
269    }
270}
wisp/components/file_picker.rs

wisp/components/
file_picker.rs
