fallow-cli 3.34.1

CLI for fallow, codebase intelligence for TypeScript and JavaScript
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

//! Process-level opt-in, saved reports and manual-fix contracts.
use super::common::{copy_fixture, parse_json, run_fallow_in_root};

#[test]
fn absent_component_props_cli_selection_and_saved_native_formats() {
    let dir = copy_fixture("absent-component-prop");
    let root = dir.path();
    let output = run_fallow_in_root(
        "dead-code",
        root,
        &[
            "--absent-component-props",
            "--format",
            "json",
            "--quiet",
            "--no-cache",
        ],
    );
    assert_eq!(output.code, 0, "{}", output.stderr);
    let report = parse_json(&output);
    assert_eq!(report["summary"]["absent_component_props"], 1);
    assert_eq!(
        report["absent_component_props"][0]["prop_name"],
        "highlight"
    );
    assert_eq!(
        report["absent_component_props"][0]["inspected_call_sites"][0]["path"],
        "src/main.tsx"
    );
    let saved = root.join("report.json");
    std::fs::write(&saved, &output.stdout).unwrap();
    for format in ["human", "compact"] {
        let rendered = run_fallow_in_root(
            "dead-code",
            root,
            &[
                "--absent-component-props",
                "--format",
                format,
                "--quiet",
                "--no-cache",
            ],
        );
        assert_eq!(rendered.code, 0, "{format}: {}", rendered.stderr);
        assert!(
            rendered.stdout.contains("Card.highlight"),
            "live report omitted candidate in {format}: {}",
            rendered.stdout
        );
    }
    for format in [
        "github-summary",
        "github-annotations",
        "markdown",
        "sarif",
        "codeclimate",
    ] {
        let rendered = run_fallow_in_root(
            "report",
            root,
            &[
                "--from",
                saved.to_str().unwrap(),
                "--format",
                format,
                "--quiet",
            ],
        );
        assert_eq!(rendered.code, 0, "{format}: {}", rendered.stderr);
        assert!(
            rendered.stdout.contains("highlight"),
            "saved report omitted candidate in {format}: {}",
            rendered.stdout
        );
        assert!(
            !rendered.stdout.contains("remove it or use it"),
            "candidate advice conflates local usage in {format}"
        );
    }
    let summary = run_fallow_in_root(
        "report",
        root,
        &[
            "--from",
            saved.to_str().unwrap(),
            "--format",
            "github-summary",
            "--quiet",
        ],
    );
    assert!(summary.stdout.contains("Card.highlight"));
    assert!(summary.stdout.contains("src/main.tsx"));
    assert!(
        summary
            .stdout
            .contains("static analysis does not prove runtime unreachability")
    );
}

#[test]
fn configured_error_candidates_gate_cli_and_remain_manual_in_fix_dry_run() {
    let dir = copy_fixture("absent-component-prop");
    std::fs::write(
        dir.path().join(".fallowrc.json"),
        r#"{"rules":{"absent-component-props":"error"}}"#,
    )
    .unwrap();
    let output = run_fallow_in_root(
        "dead-code",
        dir.path(),
        &[
            "--absent-component-props",
            "--format",
            "json",
            "--quiet",
            "--no-cache",
        ],
    );
    assert_eq!(output.code, 1, "{}", output.stderr);
    let finding = parse_json(&output)["absent_component_props"][0].clone();
    assert_eq!(finding["effective_severity"], "error");
    assert!(
        finding["actions"]
            .as_array()
            .unwrap()
            .iter()
            .all(|action| action["auto_fixable"] == false)
    );
    let before = std::fs::read(dir.path().join("src/Card.tsx")).unwrap();
    let dry = run_fallow_in_root(
        "fix",
        dir.path(),
        &["--dry-run", "--format", "json", "--quiet", "--no-cache"],
    );
    assert!(dry.code == 0 || dry.code == 1, "{}", dry.stderr);
    let report = parse_json(&dry);
    assert!(
        !report["fixes"]
            .as_array()
            .unwrap()
            .iter()
            .any(|fix| fix["name"] == "highlight")
    );
    assert_eq!(
        std::fs::read(dir.path().join("src/Card.tsx")).unwrap(),
        before
    );
}