weavatrix-scan 0.4.0

Deterministic, safe repository scanner for code intelligence
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

#[allow(dead_code)]
mod support;

use std::path::Path;
use support::Fixture;
use weavatrix_scan::{NamedFileTypes, ScanOptions, Scanner, WalkBuilder};

#[test]
fn multi_root_builder_preserves_native_roots_and_relative_paths() {
    let first = Fixture::new("weavatrix-p2-multi-first");
    let second = Fixture::new("weavatrix-p2-multi-second");
    first.write("first.rs", "fn first() {}\n");
    second.write("second.rs", "fn second() {}\n");

    let entries = WalkBuilder::new(&first.root)
        .add_root(&second.root)
        .sort_by_file_name()
        .build()
        .collect::<Result<Vec<_>, _>>()
        .unwrap();
    let files = entries
        .iter()
        .filter(|entry| entry.is_file())
        .map(|entry| {
            (
                entry.path().parent().unwrap().to_path_buf(),
                entry.relative_path().to_path_buf(),
            )
        })
        .collect::<Vec<_>>();

    assert_eq!(
        files,
        [
            (first.root.clone(), "first.rs".into()),
            (second.root.clone(), "second.rs".into())
        ]
    );
}

#[test]
fn sorting_filtering_and_contents_first_match_builder_contracts() {
    let fixture = Fixture::new("weavatrix-p2-builder");
    fixture.write("b/file.rs", "fn b() {}\n");
    fixture.write("a/file.rs", "fn a() {}\n");
    fixture.write("skip/hidden.rs", "fn hidden() {}\n");

    let sorted = WalkBuilder::new(&fixture.root)
        .sort_by_name(|left, right| right.cmp(left))
        .filter_directories(|entry| entry.file_name() != "skip")
        .build()
        .collect::<Result<Vec<_>, _>>()
        .unwrap();
    let depth_one = sorted
        .iter()
        .filter(|entry| entry.depth() == 1)
        .map(|entry| entry.file_name().to_string_lossy().into_owned())
        .collect::<Vec<_>>();
    assert_eq!(depth_one, ["b", "a"]);
    assert!(
        sorted
            .iter()
            .all(|entry| !entry.path().ends_with(Path::new("skip/hidden.rs")))
    );

    let contents_first = WalkBuilder::new(&fixture.root)
        .sort_by_file_name()
        .filter_directories(|entry| entry.file_name() != "skip")
        .contents_first(true)
        .build()
        .collect::<Result<Vec<_>, _>>()
        .unwrap();
    let positions = |suffix: &str| {
        contents_first
            .iter()
            .position(|entry| entry.path().ends_with(suffix))
            .unwrap()
    };
    assert!(positions("a/file.rs") < positions("a"));
    assert!(positions("b/file.rs") < positions("b"));
    assert!(
        contents_first
            .last()
            .unwrap()
            .relative_path()
            .as_os_str()
            .is_empty()
    );
}

#[test]
fn named_file_types_combine_with_direct_extensions() {
    let fixture = Fixture::new("weavatrix-p2-types");
    fixture.write("lib.rs", "fn run() {}\n");
    fixture.write("view.tsx", "export const View = () => null;\n");
    fixture.write("main.go", "package main\n");
    fixture.write("README.md", "# docs\n");
    let types = NamedFileTypes::new()
        .with_type("rust", ["rs"])
        .with_type("web", ["ts", "tsx"])
        .select(["rust", "web"]);
    let report = Scanner::new(&fixture.root)
        .options(
            ScanOptions::default()
                .with_extensions(["md"])
                .with_file_types(types)
                .metadata_only(),
        )
        .scan()
        .unwrap();
    let files = report
        .files
        .iter()
        .map(|file| file.relative.as_str())
        .collect::<Vec<_>>();

    assert_eq!(files, ["README.md", "lib.rs", "view.tsx"]);
}

#[test]
fn custom_sort_can_group_directories_before_files() {
    let fixture = Fixture::new("weavatrix-p2-custom-sort");
    fixture.write("z.rs", "fn z() {}\n");
    fixture.write("a/file.rs", "fn a() {}\n");
    let entries = WalkBuilder::new(&fixture.root)
        .sort_by(|left, right| {
            let left_is_file = left.file_type().is_ok_and(|kind| kind.is_file());
            let right_is_file = right.file_type().is_ok_and(|kind| kind.is_file());
            left_is_file
                .cmp(&right_is_file)
                .then_with(|| left.file_name().cmp(&right.file_name()))
        })
        .build()
        .collect::<Result<Vec<_>, _>>()
        .unwrap();

    assert_eq!(entries[1].file_name(), "a");
}