arborist-cli 0.2.0

CLI for arborist-metrics: cognitive/cyclomatic complexity and SLOC metrics
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

use std::io::{self, IsTerminal, Write};

use arborist::FileReport;
use comfy_table::{ContentArrangement, Table};

use crate::analysis::FlatFunction;
use crate::cli::AnalyzeArgs;
use crate::error::ArboristError;

pub fn write_reports(reports: &[FileReport], args: &AnalyzeArgs) -> Result<(), ArboristError> {
    let stdout = io::stdout();
    let mut out = stdout.lock();
    let is_tty = stdout.is_terminal();

    for (i, report) in reports.iter().enumerate() {
        if i > 0 {
            writeln!(out)?;
        }

        writeln!(
            out,
            "{} ({}) \u{2014} {} function{}, {} SLOC",
            report.path,
            report.language,
            report.functions.len(),
            if report.functions.len() == 1 { "" } else { "s" },
            report.file_sloc,
        )?;

        if report.functions.is_empty() {
            writeln!(out)?;
            continue;
        }

        let mut table = Table::new();
        table.set_content_arrangement(ContentArrangement::Dynamic);

        if !is_tty {
            table.load_preset(comfy_table::presets::NOTHING);
        }

        table.set_header(vec!["Function", "Lines", "Cognitive", "Cyclomatic", "SLOC"]);

        for func in &report.functions {
            let cognitive_str = if let Some(threshold) = args.threshold {
                if func.cognitive > threshold {
                    if is_tty {
                        format!("{} \u{26a0}", func.cognitive)
                    } else {
                        format!("{} !", func.cognitive)
                    }
                } else {
                    func.cognitive.to_string()
                }
            } else {
                func.cognitive.to_string()
            };

            table.add_row(vec![
                func.name.clone(),
                format!("{}-{}", func.start_line, func.end_line),
                cognitive_str,
                func.cyclomatic.to_string(),
                func.sloc.to_string(),
            ]);
        }

        writeln!(out, "{table}")?;
    }

    Ok(())
}

pub fn write_flat(flat: &[FlatFunction], args: &AnalyzeArgs) -> Result<(), ArboristError> {
    let stdout = io::stdout();
    let mut out = stdout.lock();
    let is_tty = stdout.is_terminal();

    let mut table = Table::new();
    table.set_content_arrangement(ContentArrangement::Dynamic);

    if !is_tty {
        table.load_preset(comfy_table::presets::NOTHING);
    }

    table.set_header(vec!["Function", "File", "Cognitive", "Cyclomatic", "SLOC"]);

    for func in flat {
        let cognitive_str = if let Some(threshold) = args.threshold {
            if func.cognitive > threshold {
                if is_tty {
                    format!("{} \u{26a0}", func.cognitive)
                } else {
                    format!("{} !", func.cognitive)
                }
            } else {
                func.cognitive.to_string()
            }
        } else {
            func.cognitive.to_string()
        };

        table.add_row(vec![
            func.name.clone(),
            func.file_path.clone(),
            cognitive_str,
            func.cyclomatic.to_string(),
            func.sloc.to_string(),
        ]);
    }

    writeln!(out, "{table}")?;

    Ok(())
}