elio 1.3.0

Snappy, batteries-included terminal file manager with rich previews, inline images, bulk actions, and trash support.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

use notify::{Config, Event, EventKind, RecommendedWatcher, RecursiveMode, Watcher};
use std::{
    path::{Path, PathBuf},
    sync::mpsc,
    time::Duration,
};

const DIRECTORY_WATCH_DEBOUNCE: Duration = Duration::from_millis(45);

pub(crate) type DirectoryWatcher = RecommendedWatcher;

#[derive(Clone, Debug)]
pub(crate) enum DirectoryWatchEvent {
    Changed(Vec<PathBuf>),
    Rescan,
}

pub(crate) fn directory_watch_debounce() -> Duration {
    DIRECTORY_WATCH_DEBOUNCE
}

pub(crate) fn start_directory_watcher(
    path: &Path,
    tx: &mpsc::Sender<DirectoryWatchEvent>,
) -> notify::Result<DirectoryWatcher> {
    let event_tx = tx.clone();
    let mut watcher = RecommendedWatcher::new(
        move |result: notify::Result<Event>| match result {
            Ok(event) => {
                if !should_schedule_reload(&event) {
                    return;
                }
                let message = if event.paths.is_empty() {
                    DirectoryWatchEvent::Rescan
                } else {
                    DirectoryWatchEvent::Changed(event.paths)
                };
                let _ = event_tx.send(message);
            }
            Err(_) => {
                let _ = event_tx.send(DirectoryWatchEvent::Rescan);
            }
        },
        Config::default(),
    )?;
    watcher.watch(path, RecursiveMode::NonRecursive)?;
    Ok(watcher)
}

pub(crate) fn event_affects_visible_entries(paths: &[PathBuf], show_hidden: bool) -> bool {
    show_hidden
        || paths.is_empty()
        || paths.iter().any(|path| {
            path.file_name()
                .and_then(|name| name.to_str())
                .map(|name| !name.starts_with('.'))
                .unwrap_or(true)
        })
}

fn should_schedule_reload(event: &Event) -> bool {
    !matches!(event.kind, EventKind::Access(_))
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn hidden_paths_are_ignored_when_dotfiles_are_hidden() {
        assert!(!event_affects_visible_entries(
            &[PathBuf::from("/tmp/.secret")],
            false,
        ));
    }

    #[test]
    fn visible_paths_trigger_reload_when_dotfiles_are_hidden() {
        assert!(event_affects_visible_entries(
            &[PathBuf::from("/tmp/file.txt")],
            false,
        ));
    }

    #[test]
    fn empty_path_events_force_rescan() {
        assert!(event_affects_visible_entries(&[], false));
    }
}