normalize-native-rules 0.3.1

Native rule checks for normalize (stale-summary, check-refs, stale-docs, check-examples)
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

//! `high-fan-in` native rule — flags files that are imported by too many other files.
//!
//! High fan-in is a structural design smell: a file with many dependents is a fragile
//! shared dependency — any change to its interface ripples across the codebase.
//!
//! Requires the structural index (`normalize structure rebuild`).
//!
//! # Configuration
//!
//! ```toml
//! [rules.rule."high-fan-in"]
//! threshold = 15   # default: 20
//! ```

use normalize_output::diagnostics::{DiagnosticsReport, Issue, Severity, ToolFailure};
use std::path::Path;

/// Build a `DiagnosticsReport` for the `high-fan-in` rule.
///
/// Opens the structural index under `root`, queries fan-in counts per file, and
/// emits a warning for each file that is imported by strictly more than `threshold`
/// distinct files.
pub async fn build_high_fan_in_report(root: &Path, threshold: usize) -> DiagnosticsReport {
    let mut report = DiagnosticsReport::new();

    let db_path = crate::check_refs::normalize_dir_for_root(root).join("index.sqlite");
    let idx = match normalize_facts::FileIndex::open(&db_path, root).await {
        Ok(idx) => idx,
        Err(e) => {
            report.tool_errors.push(ToolFailure {
                tool: "high-fan-in".into(),
                message: format!(
                    "failed to open index at {}: {}. Run `normalize structure rebuild` first.",
                    db_path.display(),
                    e
                ),
            });
            return report;
        }
    };

    let fan_in = match idx.import_fan_in_by_file().await {
        Ok(v) => v,
        Err(e) => {
            report.tool_errors.push(ToolFailure {
                tool: "high-fan-in".into(),
                message: format!("failed to query imports table: {e}"),
            });
            return report;
        }
    };

    for (file, count) in &fan_in {
        if *count > threshold {
            report.issues.push(Issue {
                file: file.clone(),
                line: Some(1),
                column: None,
                end_line: None,
                end_column: None,
                rule_id: "high-fan-in".into(),
                message: format!(
                    "file is imported by {count} modules (threshold: {threshold})"
                ),
                severity: Severity::Warning,
                source: "high-fan-in".into(),
                related: vec![],
                suggestion: Some(
                    "consider whether this file has too many responsibilities or whether callers could reduce their dependency on it".into(),
                ),
            });
        }
    }

    report.files_checked = fan_in.len();
    report.sources_run.push("high-fan-in".into());
    report
}