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

use assert_cmd::Command;
use predicates::prelude::*;

fn cmd() -> Command {
    Command::cargo_bin("arborist").unwrap()
}

/// T020: verify `--format json` produces valid JSON with FileReport schema fields
#[test]
fn json_output_valid_schema() {
    let output = cmd()
        .args(["tests/fixtures/simple.rs", "--format", "json"])
        .output()
        .unwrap();

    assert!(output.status.success());
    let stdout = String::from_utf8(output.stdout).unwrap();
    let parsed: serde_json::Value = serde_json::from_str(&stdout).unwrap();
    let arr = parsed.as_array().unwrap();
    assert_eq!(arr.len(), 1);

    let report = &arr[0];
    assert!(report.get("path").is_some());
    assert!(report.get("language").is_some());
    assert!(report.get("functions").is_some());
    assert!(report.get("file_cognitive").is_some());
    assert!(report.get("file_cyclomatic").is_some());
    assert!(report.get("file_sloc").is_some());
}

/// T023: verify JSON output fields match arborist-metrics FileReport serialization
#[test]
fn json_output_function_fields() {
    let output = cmd()
        .args(["tests/fixtures/simple.rs", "--format", "json"])
        .output()
        .unwrap();

    assert!(output.status.success());
    let stdout = String::from_utf8(output.stdout).unwrap();
    let parsed: serde_json::Value = serde_json::from_str(&stdout).unwrap();
    let func = &parsed[0]["functions"][0];

    assert!(func.get("name").is_some());
    assert!(func.get("start_line").is_some());
    assert!(func.get("end_line").is_some());
    assert!(func.get("cognitive").is_some());
    assert!(func.get("cyclomatic").is_some());
    assert!(func.get("sloc").is_some());
}

/// T056: verify `--format csv` produces CSV with correct header row
#[test]
fn csv_output_header() {
    cmd()
        .args(["tests/fixtures/simple.rs", "--format", "csv"])
        .assert()
        .success()
        .stdout(predicate::str::starts_with(
            "file,language,function,line_start,line_end,cognitive,cyclomatic,sloc\n",
        ));
}

/// T057: verify CSV with directory produces multiple rows across files
#[test]
fn csv_directory_multiple_rows() {
    let output = cmd()
        .args(["tests/fixtures/nested_project/src/", "--format", "csv"])
        .output()
        .unwrap();

    assert!(output.status.success());
    let stdout = String::from_utf8(output.stdout).unwrap();
    let lines: Vec<&str> = stdout.lines().collect();
    // header + at least 3 functions (compute, transform, main)
    assert!(
        lines.len() >= 4,
        "expected header + 3+ data rows, got {lines:?}"
    );
}

/// T058: verify CSV with no-function file produces header only
#[test]
fn csv_no_functions_header_only() {
    let output = cmd()
        .args(["tests/fixtures/no_functions.rs", "--format", "csv"])
        .output()
        .unwrap();

    assert!(output.status.success());
    let stdout = String::from_utf8(output.stdout).unwrap();
    let lines: Vec<&str> = stdout.lines().collect();
    assert_eq!(lines.len(), 1, "expected header only, got {lines:?}");
    assert!(lines[0].starts_with("file,language,function"));
}