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
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

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

pub(crate) fn execute<'a>(
    request: &'a Request,
    query: &str,
    limit: usize,
    crate_: Option<&str>,
) -> (Document<'a>, bool) {
    log::info!("Searching for {query}");

    let crate_names: Vec<_> = match crate_ {
        Some(crate_) => vec![crate_],
        None => request
            .list_available_crates()
            .map(|ci| ci.name())
            .collect(),
    };

    // Search using Navigator's built-in search
    let scored_results = match request.search(query, &crate_names) {
        Ok(results) => results,
        Err(suggestions) => {
            // No crates could be loaded - show suggestions
            let mut nodes = vec![DocumentNode::paragraph(vec![Span::plain(format!(
                "No crates could be loaded for search."
            ))])];

            if !suggestions.is_empty() {
                nodes.push(DocumentNode::paragraph(vec![Span::plain(
                    "Did you mean one of these?",
                )]));

                let items: Vec<_> = suggestions
                    .into_iter()
                    .take(5)
                    .filter(|s| s.score() > 0.8)
                    .map(|s| {
                        let mut content = vec![DocumentNode::paragraph(vec![Span::plain(
                            s.path().to_string(),
                        )])];
                        if let Some(item) = s.item() {
                            content.push(DocumentNode::paragraph(vec![Span::plain(format!(
                                "({:?})",
                                item.kind()
                            ))]));
                        }
                        ListItem::new(content)
                    })
                    .collect();

                if !items.is_empty() {
                    nodes.push(DocumentNode::List { items });
                }
            }

            return (Document::from(nodes), true);
        }
    };

    log::info!("Found {} matching items", scored_results.len());

    // Handle empty results
    if scored_results.is_empty() {
        if query.is_empty() {
            // Empty query - show search instructions
            let doc = Document::from(vec![
                DocumentNode::Heading {
                    level: HeadingLevel::Title,
                    spans: vec![Span::plain("Search")],
                },
                DocumentNode::paragraph(vec![Span::plain(
                    "Type to search. Press Tab to toggle between current crate and all crates.",
                )]),
            ]);
            return (doc, false);
        } else {
            // No matches for query
            let error_doc = Document::from(vec![
                DocumentNode::Heading {
                    level: HeadingLevel::Title,
                    spans: vec![Span::plain("No results")],
                },
                DocumentNode::paragraph(vec![
                    Span::plain("No results found for '"),
                    Span::plain(query.to_string()),
                    Span::plain("'"),
                ]),
            ]);
            return (error_doc, false);
        }
    }

    // Get top values for normalization (so best result = 100 in each metric)
    let top_score = scored_results
        .first()
        .map(|r| r.score)
        .unwrap_or(1.0)
        .max(1.0);

    let top_relevance = scored_results
        .iter()
        .map(|r| r.relevance)
        .fold(0.0f32, |a, b| a.max(b))
        .max(1.0);

    let top_authority = scored_results
        .iter()
        .map(|r| r.authority)
        .fold(0.0f32, |a, b| a.max(b))
        .max(0.01); // Avoid division by zero

    let mut nodes = vec![DocumentNode::Heading {
        level: HeadingLevel::Title,
        spans: vec![
            Span::plain("Search results for '"),
            Span::emphasis(query.to_string()),
            Span::plain("'"),
        ],
    }];

    // Display up to `limit` results
    let mut list_items = vec![];

    for (i, result) in scored_results.into_iter().enumerate() {
        if i >= limit {
            break;
        }

        if let Some((item, path_segments)) =
            request.get_item_from_id_path(result.crate_name, &result.id_path)
        {
            let path = path_segments.join("::");
            let normalized_score = 100.0 * result.score / top_score;
            let normalized_relevance = 100.0 * result.relevance / top_relevance;
            let normalized_authority = 100.0 * result.authority / top_authority;

            let mut content = vec![DocumentNode::paragraph(vec![
                Span::plain(path).with_target(Some(item)),
                Span::plain(" "),
                Span::plain(format!(
                    " ({:?}) - score: {:.0} (relevance: {:.0}, authority: {:.0})",
                    item.kind(),
                    normalized_score,
                    normalized_relevance,
                    normalized_authority
                )),
            ])];

            if let Some(docs) = request.docs_to_show(item, TruncationLevel::SingleLine) {
                content.extend(docs);
            }

            list_items.push(ListItem::new(content));
        }
    }

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

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