ferritin 0.8.0

Human-friendly CLI for browsing Rust 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

use crate::request::Request;
use crate::styled_string::{Document, DocumentNode, HeadingLevel, ListItem, ShowWhen, Span};

pub(crate) fn execute<'a>(request: &'a Request) -> (Document<'a>, bool, Option<&'a str>) {
    let mut nodes = vec![DocumentNode::Heading {
        level: HeadingLevel::Title,
        spans: vec![Span::plain("Available crates:")],
    }];

    let mut list_items = vec![];

    log::info!("Listing available crates");

    let mut available_crates = request.list_available_crates().collect::<Vec<_>>();

    log::info!(
        "Listing available crates ({} found)",
        available_crates.len()
    );

    available_crates.sort_by(|a, b| a.name().cmp(b.name()));

    // Find the default crate if any
    let default_crate = available_crates
        .iter()
        .find(|c| c.is_default_crate())
        .map(|c| c.name());

    // If no local project, show helpful message
    if request.local_source().is_none() {
        nodes.push(DocumentNode::paragraph(vec![Span::plain(
            "No Rust project detected. You can still navigate to:",
        )]));
    }

    // Format all crates uniformly - extract all needed data to avoid lifetime issues
    for crate_info in available_crates {
        let crate_name = crate_info.name().to_string();
        let is_default = crate_info.is_default_crate();
        let is_workspace = crate_info.provenance().is_workspace();
        let version = crate_info.version();
        let used_by = crate_info.used_by();
        let description = crate_info.description().as_ref().map(|d| d.to_string());

        let mut spans = vec![];
        if is_default {
            spans.push(Span::plain(" (workspace-local, aliased as "));
            spans.push(Span::strong("crate"));
            spans.push(Span::plain(")"));
        } else if is_workspace {
            spans.push(Span::plain(" (workspace-local)"));
        } else {
            if let Some(version) = version {
                spans.push(Span::plain(format!(" {version}")));
            }

            if !used_by.is_empty() {
                spans.push(Span::plain(" ("));
                for (n, used_by) in used_by.iter().enumerate() {
                    if n != 0 {
                        spans.push(Span::plain(", "));
                    }
                    spans.push(Span::emphasis(used_by.to_string()));
                }
                spans.push(Span::plain(")"));
            }
        }

        if let Some(description) = description {
            let description = description.replace('\n', " ");
            spans.push(Span::plain("\n    "));
            spans.push(Span::plain(description));
        }

        // Prepend crate name label to spans
        let mut all_spans = vec![Span::strong(crate_name.clone()).with_path(crate_name)];
        if !spans.is_empty() {
            all_spans.push(Span::plain(" "));
            all_spans.extend(spans);
        }

        list_items.push(ListItem::new(vec![DocumentNode::paragraph(all_spans)]));
    }

    nodes.push(DocumentNode::List { items: list_items });

    // Show usage hints only in interactive mode when no local project
    if request.local_source().is_none() {
        nodes.push(DocumentNode::Conditional {
            show_when: ShowWhen::Interactive,
            nodes: vec![DocumentNode::paragraph(vec![Span::plain(
                "To navigate:\n\
                • Press 'g' and enter a path like \"std::vec::Vec\"\n\
                • Press 's' to search within a crate\n\
                • Click on any item above to explore\n\n\
                To view documentation for a specific crate from docs.rs:\n\
                • Press 'g' and enter \"crate_name\" or \"crate_name::Item\"",
            )])],
        });
    }

    (Document::from(nodes), false, default_crate)
}