sniff-cli 0.1.0

An exhaustive LLM-backed slop finder for codebases
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

use crate::report_types::StaticFlag;
use crate::roles::is_utility_helper_name;
use crate::types::{FileRecord, FindingTier};
use std::path::{Path, PathBuf};
use std::process::Command;

use super::similarity;

struct ChurnMetrics {
    commit_count: usize,
    revert_count: usize,
}

fn collect_churn_metrics(repo_root: &Path, file_path: &str) -> Option<ChurnMetrics> {
    let rel = repo_relative_path(repo_root, file_path);
    let rel_str = rel.to_string_lossy();
    let messages = git_output(
        repo_root,
        &["log", "--follow", "--format=%s", "--", &rel_str],
    )?
    .lines()
    .map(|line| line.trim().to_string())
    .filter(|line| !line.is_empty())
    .collect::<Vec<_>>();
    let commit_count = messages.len();
    if commit_count == 0 {
        return None;
    }
    let revert_count = messages
        .iter()
        .filter(|msg| {
            let msg = msg.to_lowercase();
            msg.contains("revert") || msg.contains("rollback") || msg.contains("undo")
        })
        .count();

    Some(ChurnMetrics {
        commit_count,
        revert_count,
    })
}

fn churn_reasons(metrics: &ChurnMetrics) -> Vec<String> {
    let mut reasons = Vec::new();
    if metrics.commit_count >= 8 {
        reasons.push(format!(
            "high churn ({} commits touched this file)",
            metrics.commit_count
        ));
    }
    if metrics.revert_count >= 1 && metrics.commit_count >= 3 {
        reasons.push(format!(
            "rework-heavy file ({} commits, {} revert-like commits)",
            metrics.commit_count, metrics.revert_count
        ));
    }
    reasons
}

fn git_output(repo_root: &Path, args: &[&str]) -> Option<String> {
    let output = Command::new("git")
        .current_dir(repo_root)
        .args(args)
        .output()
        .ok()?;
    if !output.status.success() {
        return None;
    }
    String::from_utf8(output.stdout).ok()
}

fn repo_relative_path(repo_root: &Path, file_path: &str) -> PathBuf {
    let path = Path::new(file_path);
    if let Ok(stripped) = path.strip_prefix(repo_root) {
        stripped.to_path_buf()
    } else {
        path.to_path_buf()
    }
}

fn is_utility_surface(file: &FileRecord) -> bool {
    !file.methods.is_empty()
        && file
            .methods
            .iter()
            .all(|method| is_utility_helper_name(&method.name))
}

pub(crate) fn churn_flags(file_records: &[FileRecord], repo_root: &Path) -> Vec<StaticFlag> {
    let mut flags = Vec::new();

    for file in file_records {
        if crate::roles::is_intentional_surface_record(file) {
            continue;
        }

        if is_utility_surface(file) {
            continue;
        }

        let Some(metrics) = collect_churn_metrics(repo_root, &file.file_path) else {
            continue;
        };
        let reasons = churn_reasons(&metrics);
        if !reasons.is_empty() {
            flags.push(similarity::make_file_flag(
                &file.file_path,
                reasons.join("; "),
                FindingTier::KindaSlop,
                "churn",
            ));
        }
    }

    flags
}