fallow-api 3.30.0

Programmatic API contract types for fallow
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

//! `fallow_api::run_dead_code_with_baseline` reads a dead-code baseline with
//! the engine function behind `fallow dead-code --baseline`.

#![expect(
    clippy::unwrap_used,
    clippy::expect_used,
    reason = "tests use unwrap and expect to keep fixture setup concise"
)]

use std::fs;
use std::path::Path;

use fallow_api::{
    AnalysisOptions, DeadCodeOptions, run_dead_code_with_baseline,
    serialize_dead_code_programmatic_json,
};
use serde_json::Value;

fn write(root: &Path, path: &str, content: &str) {
    let target = root.join(path);
    fs::create_dir_all(target.parent().unwrap()).unwrap();
    fs::write(target, content).unwrap();
}

/// `src/a.ts` has two unused exports, `unusedA` and `unusedB`.
fn project() -> tempfile::TempDir {
    let dir = tempfile::tempdir().expect("tempdir");
    let root = dir.path();
    write(
        root,
        "package.json",
        r#"{"name":"api-baseline","version":"1.0.0","main":"src/index.ts"}"#,
    );
    write(
        root,
        "src/index.ts",
        "import { used } from \"./a\";\nconsole.log(used);\n",
    );
    write(
        root,
        "src/a.ts",
        "export const used = 1;\nexport const unusedA = 2;\nexport const unusedB = 3;\n",
    );
    dir
}

fn options(root: &Path) -> DeadCodeOptions {
    DeadCodeOptions {
        analysis: AnalysisOptions {
            root: Some(root.to_path_buf()),
            no_cache: true,
            ..AnalysisOptions::default()
        },
        ..DeadCodeOptions::default()
    }
}

fn unused_export_names(report: &Value) -> Vec<String> {
    let mut names: Vec<String> = report["unused_exports"]
        .as_array()
        .into_iter()
        .flatten()
        .map(|finding| finding["export_name"].as_str().unwrap().to_string())
        .collect();
    names.sort();
    names
}

fn run(root: &Path, baseline: Option<&Path>) -> Value {
    run_dead_code_with_baseline(&options(root), baseline)
        .and_then(serialize_dead_code_programmatic_json)
        .expect("run the programmatic dead-code analysis")
}

#[test]
fn a_dead_code_baseline_hides_the_findings_it_holds() {
    let dir = project();
    let root = dir.path();
    assert_eq!(
        unused_export_names(&run(root, None)),
        ["unusedA", "unusedB"]
    );

    write(
        root,
        "baseline.json",
        r#"{"unused_files":[],"unused_exports":["src/a.ts:unusedA"],"unused_types":[],"unused_dependencies":[],"unused_dev_dependencies":[]}"#,
    );
    let report = run(root, Some(Path::new("baseline.json")));
    assert_eq!(unused_export_names(&report), ["unusedB"]);
}

#[test]
fn a_baseline_of_another_command_hides_nothing() {
    let dir = project();
    let root = dir.path();
    write(
        root,
        "dupes-baseline.json",
        r#"{"kind":"dupes","clone_groups":[]}"#,
    );
    let report = run(root, Some(Path::new("dupes-baseline.json")));
    assert_eq!(unused_export_names(&report), ["unusedA", "unusedB"]);
}

#[test]
fn an_invalid_baseline_is_an_error() {
    let dir = project();
    let root = dir.path();
    write(root, "broken.json", "{ not json");
    let error = run_dead_code_with_baseline(&options(root), Some(Path::new("broken.json")))
        .expect_err("an invalid baseline fails the run");
    assert_eq!(error.exit_code, 2);
    assert_eq!(error.code.as_deref(), Some("FALLOW_BASELINE_INVALID"));
}