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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
#![cfg_attr(coverage_nightly, coverage(off))]
//! Markdown formatting functions for context output.
//!
//! This module provides functions to format project context and deep context
//! analysis results as human-readable markdown.

use super::types::{AstItem, FileContext, GroupedItems, ProjectContext, ProjectSummary};
use crate::services::deep_context::DeepContext;

#[must_use]
#[provable_contracts_macros::contract("pmat-core.yaml", equation = "check_compliance")]
/// Format context as markdown.
pub fn format_context_as_markdown(context: &ProjectContext) -> String {
    let mut output = String::new();

    format_header(&mut output, context);
    format_summary(&mut output, &context.summary);
    format_dependencies(&mut output, &context.summary.dependencies);
    format_files(&mut output, &context.files);
    format_footer(&mut output);

    output
}

fn format_header(output: &mut String, context: &ProjectContext) {
    output.push_str(&format!(
        "# Project Context: {} Project\n\n",
        context.project_type
    ));
    output.push_str(&format!(
        "Generated: {}\n\n",
        chrono::Utc::now().format("%Y-%m-%d %H:%M:%S UTC")
    ));
}

fn format_summary(output: &mut String, summary: &ProjectSummary) {
    output.push_str("## Summary\n\n");
    output.push_str(&format!("- Files analyzed: {}\n", summary.total_files));
    output.push_str(&format!("- Functions: {}\n", summary.total_functions));
    output.push_str(&format!("- Structs: {}\n", summary.total_structs));
    output.push_str(&format!("- Enums: {}\n", summary.total_enums));
    output.push_str(&format!("- Traits: {}\n", summary.total_traits));
    output.push_str(&format!("- Implementations: {}\n", summary.total_impls));
}

fn format_dependencies(output: &mut String, dependencies: &[String]) {
    if !dependencies.is_empty() {
        output.push_str("\n## Dependencies\n\n");
        for dep in dependencies {
            output.push_str(&format!("- {dep}\n"));
        }
    }
}

fn format_files(output: &mut String, files: &[FileContext]) {
    output.push_str("\n## Files\n\n");

    for file in files {
        output.push_str(&format!("### {}\n\n", file.path));

        let grouped_items = group_items_by_type(&file.items);
        format_item_groups(output, &grouped_items);
    }
}

#[provable_contracts_macros::contract("pmat-core.yaml", equation = "check_compliance")]
pub(crate) fn group_items_by_type(items: &[AstItem]) -> GroupedItems<'_> {
    let mut grouped = GroupedItems::new();

    for item in items {
        match item {
            AstItem::Function { .. } => grouped.functions.push(item),
            AstItem::Struct { .. } => grouped.structs.push(item),
            AstItem::Enum { .. } => grouped.enums.push(item),
            AstItem::Trait { .. } => grouped.traits.push(item),
            AstItem::Impl { .. } => grouped.impls.push(item),
            AstItem::Module { .. } => grouped.modules.push(item),
            _ => {}
        }
    }

    grouped
}

#[provable_contracts_macros::contract("pmat-core.yaml", equation = "check_compliance")]
pub(crate) fn format_item_groups(output: &mut String, groups: &GroupedItems) {
    format_item_group(output, "Modules", &groups.modules, format_module_item);
    format_item_group(output, "Structs", &groups.structs, format_struct_item);
    format_item_group(output, "Enums", &groups.enums, format_enum_item);
    format_item_group(output, "Traits", &groups.traits, format_trait_item);
    format_item_group(output, "Functions", &groups.functions, format_function_item);
    format_item_group(output, "Implementations", &groups.impls, format_impl_item);
}

fn format_item_group<F>(output: &mut String, title: &str, items: &[&AstItem], formatter: F)
where
    F: Fn(&AstItem) -> String,
{
    if !items.is_empty() {
        output.push_str(&format!("**{title}:**\n"));
        for item in items {
            output.push_str(&format!("{}\n", formatter(item)));
        }
        output.push('\n');
    }
}

fn format_module_item(item: &AstItem) -> String {
    if let AstItem::Module {
        name,
        visibility,
        line,
    } = item
    {
        format!("- `{visibility} mod {name}` (line {line})")
    } else {
        String::new()
    }
}

fn format_struct_item(item: &AstItem) -> String {
    if let AstItem::Struct {
        name,
        visibility,
        fields_count,
        derives,
        line,
    } = item
    {
        let mut result = format!("- `{visibility} struct {name}` ({fields_count} fields)");
        if !derives.is_empty() {
            result.push_str(&format!(" [derives: {}]", derives.join(", ")));
        }
        result.push_str(&format!(" (line {line})"));
        result
    } else {
        String::new()
    }
}

fn format_enum_item(item: &AstItem) -> String {
    if let AstItem::Enum {
        name,
        visibility,
        variants_count,
        line,
    } = item
    {
        format!("- `{visibility} enum {name}` ({variants_count} variants) (line {line})")
    } else {
        String::new()
    }
}

fn format_trait_item(item: &AstItem) -> String {
    if let AstItem::Trait {
        name,
        visibility,
        line,
    } = item
    {
        format!("- `{visibility} trait {name}` (line {line})")
    } else {
        String::new()
    }
}

fn format_function_item(item: &AstItem) -> String {
    if let AstItem::Function {
        name,
        visibility,
        is_async,
        line,
    } = item
    {
        format!(
            "- `{} {}fn {}` (line {})",
            visibility,
            if *is_async { "async " } else { "" },
            name,
            line
        )
    } else {
        String::new()
    }
}

fn format_impl_item(item: &AstItem) -> String {
    if let AstItem::Impl {
        type_name,
        trait_name,
        line,
    } = item
    {
        match trait_name {
            Some(trait_name) => {
                format!("- `impl {trait_name} for {type_name}` (line {line})")
            }
            None => format!("- `impl {type_name}` (line {line})"),
        }
    } else {
        String::new()
    }
}

fn format_footer(output: &mut String) {
    output.push_str("---\n");
    output.push_str("Generated by paiml-mcp-agent-toolkit\n");
}

/// Format a comprehensive `DeepContext` as markdown with quality metrics
#[must_use]
#[provable_contracts_macros::contract("pmat-core.yaml", equation = "check_compliance")]
pub fn format_deep_context_as_markdown(context: &DeepContext) -> String {
    let mut output = String::new();

    // Header
    output.push_str(&format!(
        "# Deep Project Context\n\nGenerated: {}\nTool Version: {}\n\n",
        context
            .metadata
            .generated_at
            .format("%Y-%m-%d %H:%M:%S UTC"),
        context.metadata.tool_version
    ));

    // Quality Scorecard
    format_quality_scorecard(&mut output, &context.quality_scorecard);

    // Project Summary
    format_project_summary(&mut output, context);

    // Analysis Results
    format_analysis_results(&mut output, &context.analyses);

    // AST Summary
    format_ast_summary(&mut output, &context.analyses.ast_contexts);

    output
}

fn format_quality_scorecard(
    output: &mut String,
    scorecard: &crate::services::deep_context::QualityScorecard,
) {
    output.push_str("## Quality Scorecard\n\n");
    output.push_str(&format!(
        "- **Overall Health**: {:.1}%\n",
        scorecard.overall_health
    ));
    output.push_str(&format!(
        "- **Complexity Score**: {:.1}%\n",
        scorecard.complexity_score
    ));
    output.push_str(&format!(
        "- **Maintainability Index**: {:.1}%\n",
        scorecard.maintainability_index
    ));
    output.push_str(&format!(
        "- **Modularity Score**: {:.1}%\n",
        scorecard.modularity_score
    ));
    if let Some(coverage) = scorecard.test_coverage {
        output.push_str(&format!("- **Test Coverage**: {coverage:.1}%\n"));
    }
    output.push_str(&format!(
        "- **Refactoring Estimate**: {:.1} hours\n\n",
        scorecard.technical_debt_hours
    ));
}

fn format_project_summary(output: &mut String, context: &DeepContext) {
    output.push_str("## Project Summary\n\n");
    output.push_str(&format!(
        "- **Total Files**: {}\n",
        context.file_tree.total_files
    ));
    output.push_str(&format!(
        "- **Total Size**: {} bytes\n",
        context.file_tree.total_size_bytes
    ));
    output.push_str(&format!(
        "- **AST Contexts**: {}\n",
        context.analyses.ast_contexts.len()
    ));

    // Count various AST items
    let (functions, structs, enums, traits, impls) =
        count_ast_items(&context.analyses.ast_contexts);
    output.push_str(&format!("- **Functions**: {functions}\n"));
    output.push_str(&format!("- **Structs**: {structs}\n"));
    output.push_str(&format!("- **Enums**: {enums}\n"));
    output.push_str(&format!("- **Traits**: {traits}\n"));
    output.push_str(&format!("- **Implementations**: {impls}\n\n"));
}

fn format_analysis_results(
    output: &mut String,
    analyses: &crate::services::deep_context::AnalysisResults,
) {
    output.push_str("## Analysis Results\n\n");

    // Complexity Analysis - Combined formatting to reduce complexity
    if let Some(ref complexity) = analyses.complexity_report {
        output.push_str(&format!(
            "### Complexity Metrics\n\n\
            - **Total Files Analyzed**: {}\n\
            - **Median Cyclomatic Complexity**: {:.1}\n\
            - **Max Cyclomatic Complexity**: {}\n\
            - **Median Cognitive Complexity**: {:.1}\n\
            - **Max Cognitive Complexity**: {}\n\
            - **Refactoring Hours**: {:.1}\n\n",
            complexity.files.len(),
            complexity.summary.median_cyclomatic,
            complexity.summary.max_cyclomatic,
            complexity.summary.median_cognitive,
            complexity.summary.max_cognitive,
            complexity.summary.technical_debt_hours
        ));
    }

    // Churn Analysis - Combined formatting to reduce complexity
    if let Some(ref churn) = analyses.churn_analysis {
        let hotspots = if churn.summary.hotspot_files.is_empty() {
            String::new()
        } else {
            let mut hotspots_str = "- **Top Hotspots**:\n".to_string();
            for (i, hotspot) in churn.summary.hotspot_files.iter().take(5).enumerate() {
                hotspots_str.push_str(&format!("  {}. {}\n", i + 1, hotspot.display()));
            }
            hotspots_str
        };

        output.push_str(&format!(
            "### Code Churn Analysis\n\n\
            - **Analysis Period**: {} days\n\
            - **Total Files Changed**: {}\n\
            - **Total Commits**: {}\n\
            - **Hotspot Files**: {}\n{}\n",
            churn.period_days,
            churn.summary.total_files_changed,
            churn.summary.total_commits,
            churn.summary.hotspot_files.len(),
            hotspots
        ));
    }

    // Dependency Graph - Combined formatting to reduce complexity
    if let Some(ref dag) = analyses.dependency_graph {
        output.push_str(&format!(
            "### Dependency Graph Statistics\n\n\
            - **Total Nodes**: {}\n\
            - **Total Edges**: {}\n\
            - **Graph Analysis**: Dependency relationships analyzed\n\n",
            dag.nodes.len(),
            dag.edges.len()
        ));
    }

    // Dead Code Analysis - Combined formatting to reduce complexity
    if let Some(ref dead_code) = analyses.dead_code_results {
        output.push_str(&format!(
            "### Dead Code Analysis\n\n\
            - **Total Files Analyzed**: {}\n\
            - **Dead Functions Found**: {}\n\
            - **Dead Classes Found**: {}\n\
            - **Dead Lines**: {}\n\n",
            dead_code.summary.total_files_analyzed,
            dead_code.summary.dead_functions,
            dead_code.summary.dead_classes,
            dead_code.summary.total_dead_lines
        ));
    }

    // SATD Analysis - Combined formatting to reduce complexity
    if let Some(ref satd) = analyses.satd_results {
        output.push_str(&format!(
            "### Self-Admitted Debt Analysis\n\n\
            - **Total SATD Items**: {}\n\
            - **Categories**: Various debt types detected\n\n",
            satd.items.len()
        ));
    }
}

fn format_ast_summary(
    output: &mut String,
    ast_contexts: &[crate::services::deep_context::EnhancedFileContext],
) {
    if ast_contexts.is_empty() {
        return;
    }

    output.push_str("## AST Analysis\n\n");

    for enhanced_context in ast_contexts.iter().take(20) {
        // Limit to top 20 files
        let file_context = &enhanced_context.base;
        output.push_str(&format!("### {}\n\n", file_context.path));

        let grouped_items = group_items_by_type(&file_context.items);
        format_item_groups(output, &grouped_items);
    }
}

fn count_ast_items(
    ast_contexts: &[crate::services::deep_context::EnhancedFileContext],
) -> (usize, usize, usize, usize, usize) {
    let mut functions = 0;
    let mut structs = 0;
    let mut enums = 0;
    let mut traits = 0;
    let mut impls = 0;

    for enhanced_context in ast_contexts {
        for item in &enhanced_context.base.items {
            match item {
                AstItem::Function { .. } => functions += 1,
                AstItem::Struct { .. } => structs += 1,
                AstItem::Enum { .. } => enums += 1,
                AstItem::Trait { .. } => traits += 1,
                AstItem::Impl { .. } => impls += 1,
                _ => {}
            }
        }
    }

    (functions, structs, enums, traits, impls)
}