garbage-code-hunter 0.2.1

A humorous Rust code quality detector that roasts your garbage code
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

//! Commit Roaster module.
//!
//! Scans git history and roasts bad commit messages with
//! sharp but humorous feedback.

pub mod analyzer;
pub mod report;
pub mod rules;

use analyzer::AnalyzerConfig;
use anyhow::Result;
use report::ScoredCommit;
use rules::{match_rules, RuleSet};
use std::path::Path;

pub use crate::common::OutputFormat;

/// Run the commit-roaster analysis on a repository.
pub fn run(repo_path: &Path, config: &AnalyzerConfig, format: &OutputFormat) -> Result<String> {
    // Load default rules
    let ruleset = RuleSet::from_toml(rules::default_rules_toml())?;
    let active_rules = ruleset.active_rules();

    // Analyze commits
    let commits = analyzer::analyze_repo(repo_path, config)?;

    // Score each commit
    let scored_commits: Vec<ScoredCommit> = commits
        .into_iter()
        .map(|commit| {
            let first = analyzer::first_line(&commit.message);
            let issues = match_rules(first, &active_rules);
            ScoredCommit { commit, issues }
        })
        .collect();

    // Build report
    let report = report::build_report(scored_commits);

    // Format output
    match format {
        OutputFormat::Terminal => Ok(report::format_terminal(&report)),
        OutputFormat::Json => Ok(report::format_json(&report)?),
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::path::PathBuf;

    #[test]
    fn test_run_on_nonexistent_path() {
        let path = PathBuf::from("/nonexistent/repo");
        let config = AnalyzerConfig::default();
        let result = run(&path, &config, &OutputFormat::Terminal);
        assert!(result.is_err(), "Should fail on nonexistent path");
    }
}