crawk 0.3.0

Dependency crawler for Rust. It crawls so you don't have to untangle
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

use std::fmt::Write;
use std::path::Path;

use comfy_table::presets::ASCII_FULL;
use comfy_table::{ContentArrangement, Table};
use crawk::ModuleInfo;

/// Display options controlling which columns appear in the list output.
pub(crate) struct ListDisplayOptions {
    /// Show source file paths alongside module names.
    pub show_source: bool,
    /// Show visibility column.
    pub show_visibility: bool,
    /// Show target tag column (e.g. `[lib]`, `[bin:crawk]`).
    pub multi_target: bool,
}

/// Render module list in plain text format.
///
/// Columns (left to right): target tag (if `multi_target`), module path,
/// visibility (if `show_visibility`), file (if `show_source`).
pub(crate) fn render_list_plain(
    modules: &[ModuleInfo],
    opts: &ListDisplayOptions,
    crate_root: &Path,
) -> String {
    if modules.is_empty() {
        return String::new();
    }

    let needs_columns = opts.show_source || opts.show_visibility || opts.multi_target;

    let tag_width = if opts.multi_target {
        modules
            .iter()
            .map(|m| format_target_tag(m).len())
            .max()
            .unwrap_or(0)
    } else {
        0
    };
    let mod_width = if needs_columns {
        modules.iter().map(|m| m.path().len()).max().unwrap_or(0)
    } else {
        0
    };
    let vis_width = if opts.show_visibility && (opts.show_source || opts.multi_target) {
        modules
            .iter()
            .map(|m| m.visibility().to_string().len())
            .max()
            .unwrap_or(0)
    } else {
        0
    };

    let mut output = String::new();
    for module in modules {
        let path = module.path();
        let vis = module.visibility().to_string();

        if opts.multi_target {
            let tag = format_target_tag(module);
            write!(&mut output, "{tag:<tag_width$} ").ok();
        }

        match (opts.show_visibility, opts.show_source) {
            (false, false) => writeln!(&mut output, "{path}").ok(),
            (false, true) => {
                let source = make_relative(module.source(), crate_root);
                writeln!(&mut output, "{path:<mod_width$}  {source}").ok()
            }
            (true, false) => writeln!(&mut output, "{path:<mod_width$}  {vis}").ok(),
            (true, true) => {
                let source = make_relative(module.source(), crate_root);
                writeln!(
                    &mut output,
                    "{path:<mod_width$}  {vis:<vis_width$}  {source}"
                )
                .ok()
            }
        };
    }
    output
}

/// Render module list as a Unicode table.
///
/// Columns (left to right): Target (if `multi_target`), Module,
/// Visibility (if `show_visibility`), File (if `show_source`).
pub(crate) fn render_list_table(
    modules: &[ModuleInfo],
    opts: &ListDisplayOptions,
    crate_root: &Path,
) -> String {
    let mut table = Table::new();
    table
        .load_preset(ASCII_FULL)
        .set_content_arrangement(ContentArrangement::Dynamic);

    // Build header
    let mut header: Vec<&str> = Vec::new();
    if opts.multi_target {
        header.push("Target");
    }
    header.push("Module");
    if opts.show_visibility {
        header.push("Visibility");
    }
    if opts.show_source {
        header.push("File");
    }
    table.set_header(header);

    // Build rows
    for module in modules {
        let mut row: Vec<String> = Vec::new();
        if opts.multi_target {
            row.push(module.target().to_string());
        }
        row.push(module.path().to_owned());
        if opts.show_visibility {
            row.push(module.visibility().to_string());
        }
        if opts.show_source {
            row.push(make_relative(module.source(), crate_root));
        }
        table.add_row(row);
    }

    format!("{table}\n")
}

/// Format the target tag for plain output, e.g. `[lib]`, `[bin:crawk]`.
fn format_target_tag(module: &ModuleInfo) -> String {
    format!("[{}]", module.target())
}

fn make_relative(source: &Path, crate_root: &Path) -> String {
    source
        .strip_prefix(crate_root)
        .unwrap_or(source)
        .to_string_lossy()
        .into_owned()
}