smackdebt 0.3.0

Find costly code debt and see whether your changes make it better
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

use std::fs;

use assert_cmd::Command;
use tempfile::TempDir;
use unicode_width::UnicodeWidthStr;

fn snapshot(name: &str, text: &str, width: usize) {
    for line in text.lines() {
        assert!(
            line.width() <= width,
            "{name}: line exceeds {width} columns: {line}"
        );
    }
    let path = std::path::Path::new(env!("CARGO_MANIFEST_DIR"))
        .join("tests/snapshots")
        .join(name);
    assert_eq!(text, fs::read_to_string(path).unwrap(), "{name}");
}

#[test]
fn help_and_gate_fit_narrow_and_wide_terminals() {
    let project = TempDir::new().unwrap();
    fs::create_dir(project.path().join("src")).unwrap();
    fs::write(
        project
            .path()
            .join("src/shipping_with_a_long_descriptive_name.js"),
        "function shipping(a, b) { if (a) { if (b) { return 1; } } return 0; }\n",
    )
    .unwrap();
    fs::write(
        project.path().join(".smackdebt.toml"),
        "[thresholds.cognitive]\nwatch = 1\nhigh = 2\n",
    )
    .unwrap();
    fs::write(
        project.path().join("baseline.tsv"),
        "# smackdebt gate baseline v1\npath\tsignal\thigh\twatch\n",
    )
    .unwrap();
    for width in [50, 80, 120] {
        for (name, args, code) in [
            ("help", vec!["--help"], 0),
            ("gate", vec!["gate", "--baseline", "baseline.tsv"], 3),
            (
                "gate-decorated",
                vec!["gate", "--baseline", "baseline.tsv", "--color", "always"],
                3,
            ),
        ] {
            let output = Command::new(assert_cmd::cargo::cargo_bin!("smackdebt"))
                .current_dir(project.path())
                .args(args)
                .env("HOME", project.path())
                .env("XDG_CONFIG_HOME", project.path())
                .env("COLUMNS", width.to_string())
                .env("NO_COLOR", "1")
                .env("GIT_CONFIG_GLOBAL", "/dev/null")
                .env("GIT_CONFIG_SYSTEM", "/dev/null")
                .assert()
                .code(code)
                .stderr("")
                .get_output()
                .stdout
                .clone();
            let raw = String::from_utf8(output).unwrap();
            let text = console::strip_ansi_codes(&raw);
            if name == "gate-decorated" {
                assert!(raw.contains("\x1b["));
                assert!(text.contains('\u{f062}'));
            }
            snapshot(&format!("{name}-{width}.terminal.txt"), &text, width);
        }
    }
}