tidy/
walk.rs

Help
1use std::ffi::OsStr;
2use std::fs::File;
3use std::io::Read;
4use std::path::Path;
5
6use ignore::DirEntry;
7
8/// The default directory filter.
9pub fn filter_dirs(path: &Path) -> bool {
10    // bootstrap/etc
11    let skip = [
12        "tidy-test-file",
13        "compiler/rustc_codegen_cranelift",
14        "compiler/rustc_codegen_gcc",
15        "src/llvm-project",
16        "library/backtrace",
17        "library/portable-simd",
18        "library/stdarch",
19        "src/tools/cargo",
20        "src/tools/clippy",
21        "src/tools/libcxx-version",
22        "src/tools/miri",
23        "src/tools/rust-analyzer",
24        "src/tools/rustc-perf",
25        "src/tools/rustfmt",
26        "src/tools/enzyme",
27        "src/doc/book",
28        "src/doc/edition-guide",
29        "src/doc/embedded-book",
30        "src/doc/nomicon",
31        "src/doc/rust-by-example",
32        "src/doc/rustc-dev-guide",
33        "src/doc/reference",
34        "src/gcc",
35        "src/bootstrap/target",
36        "vendor",
37    ];
38    skip.iter().any(|p| path.ends_with(p))
39}
40
41/// Filter for only files that end in `.rs`.
42pub fn filter_not_rust(path: &Path) -> bool {
43    path.extension() != Some(OsStr::new("rs")) && !path.is_dir()
44}
45
46pub fn walk(
47    path: &Path,
48    skip: impl Send + Sync + 'static + Fn(&Path, bool) -> bool,
49    f: &mut dyn FnMut(&DirEntry, &str),
50) {
51    walk_many(&[path], skip, f);
52}
53
54pub fn walk_many(
55    paths: &[&Path],
56    skip: impl Send + Sync + 'static + Fn(&Path, bool) -> bool,
57    f: &mut dyn FnMut(&DirEntry, &str),
58) {
59    let mut contents = Vec::new();
60    walk_no_read(paths, skip, &mut |entry| {
61        contents.clear();
62        let mut file = t!(File::open(entry.path()), entry.path());
63        t!(file.read_to_end(&mut contents), entry.path());
64        let contents_str = match std::str::from_utf8(&contents) {
65            Ok(s) => s,
66            Err(_) => return, // skip this file
67        };
68        f(&entry, &contents_str);
69    });
70}
71
72pub(crate) fn walk_no_read(
73    paths: &[&Path],
74    skip: impl Send + Sync + 'static + Fn(&Path, bool) -> bool,
75    f: &mut dyn FnMut(&DirEntry),
76) {
77    let mut walker = ignore::WalkBuilder::new(paths[0]);
78    for path in &paths[1..] {
79        walker.add(path);
80    }
81    let walker = walker.filter_entry(move |e| {
82        !skip(e.path(), e.file_type().map(|ft| ft.is_dir()).unwrap_or(false))
83    });
84    for entry in walker.build().flatten() {
85        if entry.file_type().map_or(true, |kind| kind.is_dir() || kind.is_symlink()) {
86            continue;
87        }
88        f(&entry);
89    }
90}
91
92// Walk through directories and skip symlinks.
93pub(crate) fn walk_dir(
94    path: &Path,
95    skip: impl Send + Sync + 'static + Fn(&Path) -> bool,
96    f: &mut dyn FnMut(&DirEntry),
97) {
98    let mut walker = ignore::WalkBuilder::new(path);
99    let walker = walker.filter_entry(move |e| !skip(e.path()));
100    for entry in walker.build().flatten() {
101        if entry.path().is_dir() {
102            f(&entry);
103        }
104    }
105}
tidy/walk.rs

tidy/
walk.rs
