cship 1.7.0

Beautiful, Blazing-fast, Customizable Claude Code Statusline
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162

pub mod agent;
pub mod context_bar;
pub mod context_window;
pub mod cost;
pub mod model;
pub mod peak_usage;
pub mod session;
pub mod usage_limits;
pub mod vim;
pub mod workspace;

/// All native cship module names — used by `cship explain` to enumerate modules.
/// Names MUST exactly match the `render_module()` match arms below.
pub const ALL_NATIVE_MODULES: &[&str] = &[
    "cship.model",
    "cship.model.display_name",
    "cship.model.id",
    "cship.cost",
    "cship.cost.total_cost_usd",
    "cship.cost.total_duration_ms",
    "cship.cost.total_api_duration_ms",
    "cship.cost.total_lines_added",
    "cship.cost.total_lines_removed",
    "cship.context_bar",
    "cship.context_window.used_percentage",
    "cship.context_window.remaining_percentage",
    "cship.context_window.size",
    "cship.context_window.total_input_tokens",
    "cship.context_window.total_output_tokens",
    "cship.context_window.exceeds_200k",
    "cship.context_window.current_usage.input_tokens",
    "cship.context_window.current_usage.output_tokens",
    "cship.context_window.current_usage.cache_creation_input_tokens",
    "cship.context_window.current_usage.cache_read_input_tokens",
    "cship.context_window.used_tokens",
    "cship.vim",
    "cship.vim.mode",
    "cship.agent",
    "cship.agent.name",
    "cship.cwd",
    "cship.session_id",
    "cship.transcript_path",
    "cship.version",
    "cship.output_style",
    "cship.workspace.current_dir",
    "cship.workspace.project_dir",
    "cship.usage_limits",
    "cship.usage_limits.per_model",
    "cship.usage_limits.opus",
    "cship.usage_limits.sonnet",
    "cship.usage_limits.cowork",
    "cship.usage_limits.oauth_apps",
    "cship.usage_limits.extra_usage",
    "cship.peak_usage",
];

/// Static dispatch registry — the ONLY file modified when adding a new native module.
/// [Source: architecture.md#Module System Architecture]
pub fn render_module(
    name: &str,
    ctx: &crate::context::Context,
    cfg: &crate::config::CshipConfig,
) -> Option<String> {
    match name {
        "cship.model" => model::render(ctx, cfg),
        "cship.model.display_name" => model::render_display_name(ctx, cfg),
        "cship.model.id" => model::render_id(ctx, cfg),
        // Cost module — main alias and sub-fields
        "cship.cost" => cost::render(ctx, cfg),
        "cship.cost.total_cost_usd" => cost::render_total_cost_usd(ctx, cfg),
        "cship.cost.total_duration_ms" => cost::render_total_duration_ms(ctx, cfg),
        "cship.cost.total_api_duration_ms" => cost::render_total_api_duration_ms(ctx, cfg),
        "cship.cost.total_lines_added" => cost::render_total_lines_added(ctx, cfg),
        "cship.cost.total_lines_removed" => cost::render_total_lines_removed(ctx, cfg),
        // Context bar — progress bar with threshold styling
        "cship.context_bar" => context_bar::render(ctx, cfg),
        // Context window sub-fields
        "cship.context_window.used_percentage" => context_window::render_used_percentage(ctx, cfg),
        "cship.context_window.remaining_percentage" => {
            context_window::render_remaining_percentage(ctx, cfg)
        }
        "cship.context_window.size" => context_window::render_size(ctx, cfg),
        "cship.context_window.total_input_tokens" => {
            context_window::render_total_input_tokens(ctx, cfg)
        }
        "cship.context_window.total_output_tokens" => {
            context_window::render_total_output_tokens(ctx, cfg)
        }
        "cship.context_window.exceeds_200k" => context_window::render_exceeds_200k(ctx, cfg),
        "cship.context_window.current_usage.input_tokens" => {
            context_window::render_current_usage_input_tokens(ctx, cfg)
        }
        "cship.context_window.current_usage.output_tokens" => {
            context_window::render_current_usage_output_tokens(ctx, cfg)
        }
        "cship.context_window.current_usage.cache_creation_input_tokens" => {
            context_window::render_current_usage_cache_creation_input_tokens(ctx, cfg)
        }
        "cship.context_window.current_usage.cache_read_input_tokens" => {
            context_window::render_current_usage_cache_read_input_tokens(ctx, cfg)
        }
        "cship.context_window.used_tokens" => context_window::render_used_tokens(ctx, cfg),
        // Vim module — mode display
        "cship.vim" => vim::render(ctx, cfg),
        "cship.vim.mode" => vim::render_mode(ctx, cfg),
        // Agent module — agent name display
        "cship.agent" => agent::render(ctx, cfg),
        "cship.agent.name" => agent::render_name(ctx, cfg),
        // Session identity modules
        "cship.cwd" => session::render_cwd(ctx, cfg),
        "cship.session_id" => session::render_session_id(ctx, cfg),
        "cship.transcript_path" => session::render_transcript_path(ctx, cfg),
        "cship.version" => session::render_version(ctx, cfg),
        "cship.output_style" => session::render_output_style(ctx, cfg),
        // Workspace modules
        "cship.workspace.current_dir" => workspace::render_current_dir(ctx, cfg),
        "cship.workspace.project_dir" => workspace::render_project_dir(ctx, cfg),
        // Usage limits module — non-blocking thread dispatch for live API data
        "cship.usage_limits" => usage_limits::render(ctx, cfg),
        "cship.usage_limits.per_model" => usage_limits::render_per_model(ctx, cfg),
        "cship.usage_limits.opus" => usage_limits::render_opus(ctx, cfg),
        "cship.usage_limits.sonnet" => usage_limits::render_sonnet(ctx, cfg),
        "cship.usage_limits.cowork" => usage_limits::render_cowork(ctx, cfg),
        "cship.usage_limits.oauth_apps" => usage_limits::render_oauth_apps(ctx, cfg),
        "cship.usage_limits.extra_usage" => usage_limits::render_extra_usage(ctx, cfg),
        // Peak usage indicator — time-based peak-hour check
        "cship.peak_usage" => peak_usage::render(ctx, cfg),
        other => {
            tracing::warn!("cship: unknown native module '{other}' — skipping");
            None
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::config::CshipConfig;
    use crate::context::{Context, Model};

    #[test]
    fn test_dispatch_to_model_module_with_display_name_returns_some() {
        let ctx = Context {
            model: Some(Model {
                display_name: Some("Sonnet".to_string()),
                ..Default::default()
            }),
            ..Default::default()
        };
        let cfg = CshipConfig::default();
        let result = render_module("cship.model", &ctx, &cfg);
        assert!(result.is_some());
        assert!(result.unwrap().contains("Sonnet"));
    }

    #[test]
    fn test_unknown_module_name_returns_none() {
        let ctx = Context::default();
        let cfg = CshipConfig::default();
        assert!(render_module("cship.unknown_future_module", &ctx, &cfg).is_none());
    }
}