pmat 3.15.0

PMAT - Zero-config AI context generation and code quality toolkit (CLI, MCP, HTTP)
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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

#![cfg_attr(coverage_nightly, coverage(off))]
//! TDG markdown output formatting

use crate::models::tdg::{TDGHotspot, TDGSummary};
use anyhow::Result;

/// Format TDG results as Markdown
#[provable_contracts_macros::contract("pmat-core.yaml", equation = "check_compliance")]
pub fn format_tdg_markdown(
    summary: &TDGSummary,
    hotspots: &[TDGHotspot],
    include_components: bool,
) -> Result<String> {
    let mut output = String::new();

    write_tdg_header(&mut output)?;
    write_tdg_summary(&mut output, summary)?;

    if !hotspots.is_empty() {
        write_tdg_hotspots(&mut output, hotspots, include_components)?;
    }

    Ok(output)
}

/// Write TDG markdown header
pub(super) fn write_tdg_header(output: &mut String) -> Result<()> {
    use std::fmt::Write;
    writeln!(output, "# Technical Debt Gradient Analysis\n")?;
    Ok(())
}

/// Write TDG summary section
pub(super) fn write_tdg_summary(output: &mut String, summary: &TDGSummary) -> Result<()> {
    use std::fmt::Write;

    writeln!(output, "## Summary\n")?;
    writeln!(output, "- **Total Files**: {}", summary.total_files)?;
    writeln!(
        output,
        "- **Critical Files**: {} (TDG > 2.5)",
        summary.critical_files
    )?;
    writeln!(
        output,
        "- **Warning Files**: {} (TDG > 1.5)",
        summary.warning_files
    )?;
    writeln!(output, "- **Average TDG**: {:.3}", summary.average_tdg)?;
    writeln!(output, "- **95th Percentile**: {:.3}", summary.p95_tdg)?;
    writeln!(
        output,
        "- **Estimated Debt**: {:.1} hours\n",
        summary.estimated_debt_hours
    )?;

    Ok(())
}

/// Write TDG hotspots section
pub(super) fn write_tdg_hotspots(
    output: &mut String,
    hotspots: &[TDGHotspot],
    include_components: bool,
) -> Result<()> {
    use std::fmt::Write;

    writeln!(output, "## Top Hotspots\n")?;

    for (i, hotspot) in hotspots.iter().enumerate() {
        write_single_hotspot(output, i + 1, hotspot, include_components)?;
    }

    Ok(())
}

/// Write a single hotspot entry
pub(super) fn write_single_hotspot(
    output: &mut String,
    index: usize,
    hotspot: &TDGHotspot,
    include_components: bool,
) -> Result<()> {
    use std::fmt::Write;

    writeln!(output, "### {}. {}\n", index, hotspot.path)?;
    write_hotspot_basic_info(output, hotspot)?;

    if include_components {
        write_component_breakdown(output, hotspot)?;
    }

    Ok(())
}

/// Write basic hotspot information
pub(super) fn write_hotspot_basic_info(output: &mut String, hotspot: &TDGHotspot) -> Result<()> {
    use std::fmt::Write;

    writeln!(output, "- **TDG Score**: {:.3}", hotspot.tdg_score)?;
    writeln!(output, "- **Primary Factor**: {}", hotspot.primary_factor)?;
    writeln!(
        output,
        "- **Estimated Hours**: {:.1}\n",
        hotspot.estimated_hours
    )?;

    Ok(())
}

/// Write component breakdown for a hotspot
pub(super) fn write_component_breakdown(output: &mut String, hotspot: &TDGHotspot) -> Result<()> {
    use std::fmt::Write;

    writeln!(output, "#### Component Breakdown:")?;
    writeln!(
        output,
        "- Complexity: {:.3}",
        calculate_component_score(hotspot.tdg_score, 0.4)
    )?;
    writeln!(
        output,
        "- Churn: {:.3}",
        calculate_component_score(hotspot.tdg_score, 0.3)
    )?;
    writeln!(
        output,
        "- Duplication: {:.3}",
        calculate_component_score(hotspot.tdg_score, 0.2)
    )?;
    writeln!(
        output,
        "- Coupling: {:.3}\n",
        calculate_component_score(hotspot.tdg_score, 0.1)
    )?;

    Ok(())
}

/// Calculate component score with given weight
pub(super) fn calculate_component_score(tdg_score: f64, weight: f64) -> f64 {
    tdg_score * weight
}