shellist 0.3.0

Shell history analysis. Parses bash, zsh, and fish history, counts commands, and ranks by frequency.
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

use std::io;
use std::path::{Path, PathBuf};

/// Read a history file and return its contents.
///
/// ```rust,no_run
/// let content = shellist::load_history_file("/home/user/.bash_history").unwrap();
/// ```
pub fn load_history_file(path: impl AsRef<Path>) -> io::Result<String> {
    std::fs::read_to_string(path)
}

/// Resolve the default history file path (`~/.bash_history`).
///
/// Uses the `HOME` environment variable. Returns `None` if HOME is not set.
///
/// ```rust
/// let path = shellist::default_history_path().unwrap();
/// assert!(path.is_absolute());
/// assert_eq!(path.file_name().unwrap(), ".bash_history");
/// ```
pub fn default_history_path() -> Option<PathBuf> {
    crate::shell::Shell::Bash.default_history_path()
}

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

    #[test]
    fn loads_existing_file() {
        let dir = std::env::temp_dir().join("shellist_test_load");
        fs::write(&dir, "ls\ngit status\n").unwrap();
        let content = load_history_file(dir.to_str().unwrap()).unwrap();
        assert_eq!(content, "ls\ngit status\n");
        fs::remove_file(&dir).unwrap();
    }

    #[test]
    fn returns_error_for_missing_file() {
        let result = load_history_file("/tmp/nonexistent_shellist_file_12345");
        assert!(result.is_err());
    }

    #[test]
    fn default_path_ends_with_bash_history() {
        let path = default_history_path().unwrap();
        assert_eq!(path.file_name().unwrap(), ".bash_history");
    }

    #[test]
    fn default_path_is_absolute() {
        let path = default_history_path().unwrap();
        assert!(path.is_absolute());
    }
}