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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

//! Shell history analysis. Parses shell history files (bash, zsh, fish),
//! counts commands, and ranks them by frequency.
//!
//! ```rust
//! let ranked = shellist::analyze("ls\ngit\nls\ncd\ngit\nls");
//! assert_eq!(ranked, vec![
//!     ("ls".to_string(), 3),
//!     ("git".to_string(), 2),
//!     ("cd".to_string(), 1),
//! ]);
//! ```

pub mod aggregators;
pub mod completions;
pub mod date;
pub mod io;
pub mod man;
pub mod models;
pub mod output;
pub mod parsers;
pub mod search;
pub mod shell;

pub use aggregators::{
    count_commands, count_commands_at_depth, filter_by_min_frequency, filter_commands,
    rank_commands, rank_commands_ascending, top_n,
};
pub use completions::completions;
pub use date::{Bucket, bucket_key, civil_from_days, days_from_civil, parse_date_to_unix};
pub use io::{default_history_path, load_history_file};
pub use man::man_page;
pub use models::HistoryEntry;
pub use output::{
    Stats, TableOptions, compute_stats, compute_trend, format_csv, format_json, format_stats,
    format_table, format_trend,
};
pub use parsers::{
    DefaultHistoryParser, FishHistoryParser, HistoryParser, ZshHistoryParser, parse_history,
};

/// Alias for `DefaultHistoryParser` for naming consistency with `ZshHistoryParser` / `FishHistoryParser`.
pub type BashHistoryParser = DefaultHistoryParser;
pub use search::grep_filter;
pub use shell::{Shell, detect_shell};

/// Full pipeline: raw history text in, ranked commands out.
///
/// Parses input into entries, counts each command (lowercased), then ranks by
/// frequency with alphabetical tie-breaking.
///
/// ```rust
/// let result = shellist::analyze("git push\ngit commit\ncargo test\ncd ..\ncd /\n");
/// assert_eq!(result.first(), Some(&("cd".to_string(), 2)));
/// ```
pub fn analyze(input: &str) -> Vec<(String, usize)> {
    let entries = parse_history(input);
    let counts = count_commands(&entries);
    rank_commands(counts)
}

/// Detect shell format and parse with the appropriate parser.
///
/// Dispatches to `DefaultHistoryParser`, `ZshHistoryParser`, or
/// `FishHistoryParser` based on the content, then returns parsed entries
/// including any timestamps the format provides.
///
/// ```rust
/// let entries = shellist::parse_with_detected(": 1577836800:0;git push\nls\n");
/// assert_eq!(entries.len(), 2);
/// assert_eq!(entries[0].timestamp, Some(1577836800));
/// assert_eq!(entries[1].command, "ls");
/// ```
pub fn parse_with_detected(input: &str) -> Vec<HistoryEntry> {
    match detect_shell(input) {
        Shell::Bash => DefaultHistoryParser::new().parse(input),
        Shell::Zsh => ZshHistoryParser::new().parse(input),
        Shell::Fish => FishHistoryParser::new().parse(input),
    }
}