pmat 3.11.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

//! Quality Gate Example
//!
//! This example demonstrates how to use pmat's quality gate functionality
//! to enforce code quality standards in a project.
//!
//! Run with: `cargo run --example quality_gate`

use anyhow::Result;
use pmat::cli::analysis_utilities::handle_quality_gate;
use pmat::cli::enums::{QualityCheckType, QualityGateOutputFormat};
use std::path::PathBuf;

#[tokio::main]
async fn main() -> Result<()> {
    println!("🔍 Quality Gate Example\n");

    // Example 1: Run all quality checks on current directory
    println!("Example 1: Running all quality checks on current directory");
    println!("{}", "=".repeat(60));

    let result = handle_quality_gate(
        PathBuf::from("."),
        None, // No specific file
        QualityGateOutputFormat::Summary,
        false,  // Don't fail on violation
        vec![], // All checks
        15.0,   // Max 15% dead code
        2.0,    // Min entropy of 2.0
        50,     // Max cyclomatic complexity of 50
        false,  // Don't include provability
        None,   // No output file
        false,  // No performance mode
    )
    .await;

    match result {
        Ok(_) => println!("✅ Quality gate passed!\n"),
        Err(e) => println!("❌ Quality gate failed: {}\n", e),
    }

    // Example 2: Run specific checks with stricter thresholds
    println!("\nExample 2: Running specific checks with stricter thresholds");
    println!("{}", "=".repeat(60));

    let strict_result = handle_quality_gate(
        PathBuf::from("."),
        None,
        QualityGateOutputFormat::Human,
        false, // Don't fail on violation in example (to avoid CI failure)
        vec![
            QualityCheckType::Complexity,
            QualityCheckType::DeadCode,
            QualityCheckType::Satd,
        ],
        5.0, // Max 5% dead code (stricter)
        3.0, // Min entropy of 3.0 (stricter)
        20,  // Max cyclomatic complexity of 20 (stricter)
        false,
        None,
        false,
    )
    .await;

    match strict_result {
        Ok(_) => println!("✅ Strict quality gate passed!"),
        Err(e) => println!("⚠️  Strict quality gate failed (expected): {}", e),
    }

    // Example 3: Analyze a specific file
    println!("\nExample 3: Analyzing a specific file");
    println!("{}", "=".repeat(60));

    let file_result = handle_quality_gate(
        PathBuf::from("."),
        Some(PathBuf::from("src/main.rs")),
        QualityGateOutputFormat::Json,
        false,
        vec![QualityCheckType::Complexity],
        15.0,
        2.0,
        30, // Max complexity for single file
        false,
        None,
        false,
    )
    .await;

    match file_result {
        Ok(_) => println!("✅ Single file analysis complete!"),
        Err(e) => println!("❌ Single file analysis failed: {}", e),
    }

    // Example 4: Save results to file
    println!("\nExample 4: Saving quality gate results to file");
    println!("{}", "=".repeat(60));

    let output_path = PathBuf::from("quality-report.json");
    let output_result = handle_quality_gate(
        PathBuf::from("."),
        None,
        QualityGateOutputFormat::Json,
        false,
        vec![],
        15.0,
        2.0,
        50,
        true, // Include provability score
        Some(output_path.clone()),
        false,
    )
    .await;

    match output_result {
        Ok(_) => println!("✅ Quality report saved to: {}", output_path.display()),
        Err(e) => println!("❌ Failed to save report: {}", e),
    }

    println!("\n🎉 Quality gate examples completed!");
    Ok(())
}