devscout-rs 0.7.0

Fast code index for C# and TypeScript codebases -- map, find, refs, impact from the CLI.
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

use super::*;

#[test]
fn refs_json_leads_with_schema_version_ahead_of_every_existing_key() {
    let model = json_refs_model(Vec::new(), false);
    let json = refs_model_to_json(&model);
    assert!(
        json.starts_with(
            r#"{"schema_version":1,"status":"resolved","query":"Widget","id":"App.Widget","kind":"class""#
        ),
        "schema_version is the first key and every existing key keeps its slot after it: {json}"
    );
}

#[test]
fn refs_json_appends_heuristic_then_source_last_and_omits_each_when_it_has_no_value() {
    let model = json_refs_model(
        vec![
            query::InboundRow {
                file: "src/Fact.cs".into(),
                line: 4,
                heuristic: false,
                tier: None,
                source: String::new(),
                occurrence_index: None,
            },
            query::InboundRow {
                file: "src/Guess.cs".into(),
                line: 9,
                heuristic: true,
                tier: None,
                source: "var w = new Widget();".into(),
                occurrence_index: None,
            },
        ],
        true,
    );
    let json = refs_model_to_json(&model);
    assert!(
        json.contains(
            r#""rows":[{"file":"src/Fact.cs","line":4,"why":"uses-member-precise"},{"file":"src/Guess.cs","line":9,"heuristic":true,"source":"var w = new Widget();","why":"uses-member-guess"}]"#
        ),
        "{json}"
    );
}

#[test]
fn refs_json_appends_tier_after_heuristic_and_omits_it_on_a_precise_row() {
    let row = |file: &str, line: usize, tier: Option<graph::HeuristicTier>| query::InboundRow {
        file: file.into(),
        line,
        heuristic: tier.is_some(),
        tier,
        source: String::new(),
        occurrence_index: None,
    };
    let model = json_refs_model(
        vec![
            row("src/Fact.cs", 4, None),
            row("src/Ext.cs", 7, Some(graph::HeuristicTier::Ext)),
            row("src/Guess.cs", 9, Some(graph::HeuristicTier::Guess)),
        ],
        true,
    );
    let json = refs_model_to_json(&model);
    // A precise row is byte-identical to what it was before the tier
    // existed; a guessed one gains exactly one key, in the slot right after
    // the flag it refines and still before `source`.
    assert!(
        json.contains(
            r#""rows":[{"file":"src/Fact.cs","line":4,"why":"uses-member-precise"},{"file":"src/Ext.cs","line":7,"heuristic":true,"tier":"ext","why":"uses-member-ext"},{"file":"src/Guess.cs","line":9,"heuristic":true,"tier":"guess","why":"uses-member-guess"}]"#
        ),
        "{json}"
    );
    assert_eq!(
        json.matches(r#""tier""#).count(),
        2,
        "a precise row carries no trace of the key: {json}"
    );
}

#[test]
fn refs_json_omits_the_outbound_key_entirely_without_out_and_keeps_its_slot_with_it() {
    let row = || {
        vec![query::InboundRow {
            file: "src/Fact.cs".into(),
            line: 4,
            heuristic: false,
            tier: None,
            source: String::new(),
            occurrence_index: None,
        }]
    };
    let without = refs_model_to_json(&json_refs_model(row(), false));
    assert!(
        !without.contains(r#""outbound":{"inherits""#),
        "the default model must carry no outbound tables: {without}"
    );
    assert!(without.contains(r#""ambiguous":{"inbound""#), "{without}");

    let with = refs_model_to_json(&json_refs_model(row(), true));
    let outbound_at = with
        .find(r#""outbound":{"inherits""#)
        .expect("--out must emit the outbound tables");
    let inbound_at = with
        .find(r#""inbound":{"inherits""#)
        .expect("inbound is always emitted");
    let ambiguous_at = with
        .find(r#""ambiguous":{"inbound""#)
        .expect("ambiguous is always emitted");
    assert!(
        inbound_at < outbound_at && outbound_at < ambiguous_at,
        "outbound keeps JS's key slot: {with}"
    );
}

#[test]
fn member_refs_json_wraps_unchanged_resolved_models_under_status_query_members() {
    let row = || {
        vec![query::InboundRow {
            file: "src/Fact.cs".into(),
            line: 4,
            heuristic: false,
            tier: None,
            source: String::new(),
            occurrence_index: None,
        }]
    };
    let one = json_refs_model(row(), false);
    let json = member_refs_to_json("Widget", std::slice::from_ref(&one), query::Outcome::Hit);
    assert!(
        json.starts_with(
            r#"{"schema_version":1,"status":"members","query":"Widget","members":[{"schema_version":1,"status":"resolved""#
        ),
        "schema_version is the first key, ahead of status, on both the wrapper and each member: {json}"
    );
    assert!(
        json.ends_with(r#"}],"outcome":"hit"}"#),
        "the wrapper's own outcome is appended last, after the members array: {json}"
    );
    assert!(
        json.contains(&refs_model_to_json(&one)),
        "a member entry is the resolved object unchanged: {json}"
    );
}