prview 0.6.0

PR Review & Artifact Generator - cross-language PR analysis tool
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

pub mod cargo_test;
pub mod clippy;
pub mod eslint;
pub mod semgrep;
pub mod stylelint;

/// A single lint/test finding extracted from tool output.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct LintFinding {
    pub file: String,
    pub line: u32,
    pub column: Option<u32>,
    /// "error" | "warning" | "note"
    pub level: &'static str,
    pub message: String,
    pub rule_id: Option<String>,
    /// Tool identifier: "eslint" | "clippy" | "stylelint" | "cargo_test"
    pub source: &'static str,
}

/// Paths that should be excluded from findings (generated/vendored code).
///
/// Root-level segments (`target/`, `build/`, `dist/`, `coverage/`, `.next/`) are
/// only matched at the start of the path. `node_modules/` is matched anywhere
/// because it can appear nested in monorepos.
pub fn is_generated_path(path: &str) -> bool {
    let stripped = path.trim_start_matches('/');
    // Root-level generated dirs.
    const ROOT_PREFIXES: &[&str] = &["target/", "coverage/", "dist/", ".next/", "build/"];
    if ROOT_PREFIXES.iter().any(|p| stripped.starts_with(p)) {
        return true;
    }
    // node_modules can appear at any depth (monorepo).
    stripped.contains("node_modules/") || stripped.starts_with("node_modules/")
}

#[cfg(test)]
mod tests {
    use super::is_generated_path;

    #[test]
    fn generated_path_matches_known_segments() {
        assert!(is_generated_path("target/debug/build/foo.rs"));
        assert!(is_generated_path("coverage/lcov.info"));
        assert!(is_generated_path("node_modules/pkg/index.js"));
        assert!(is_generated_path("dist/app.js"));
        assert!(is_generated_path(".next/cache/chunk.js"));
        assert!(is_generated_path("build/output.css"));
    }

    #[test]
    fn generated_path_ignores_authored_files() {
        assert!(!is_generated_path("src/main.rs"));
        assert!(!is_generated_path("tests/integration.rs"));
        assert!(!is_generated_path("Cargo.toml"));
        assert!(!is_generated_path("docs/building.md"));
    }

    #[test]
    fn no_false_positives_on_substring_matches() {
        assert!(!is_generated_path("src/build/helper.rs"));
        assert!(!is_generated_path("src/target/selector.rs"));
        assert!(!is_generated_path("src/dist/chart.js"));
        assert!(!is_generated_path("rebuild/index.ts"));
    }
}