debtmap 0.16.4

Code complexity and technical debt analyzer
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
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

//! Configuration types for effect-based output writers.
//!
//! This module contains all configuration structures and their builders
//! for controlling output generation.

use std::path::PathBuf;
use std::time::Duration;

// ============================================================================
// Output Configuration
// ============================================================================

/// Configuration for output generation.
///
/// Specifies which output formats to generate and where to write them.
#[derive(Debug, Clone, Default)]
pub struct OutputConfig {
    /// Path for markdown output (if any).
    pub markdown_path: Option<PathBuf>,

    /// Path for JSON output (if any).
    pub json_path: Option<PathBuf>,

    /// Whether to output to terminal.
    pub terminal_output: bool,
}

impl OutputConfig {
    /// Create a new output config builder.
    pub fn builder() -> OutputConfigBuilder {
        OutputConfigBuilder::default()
    }

    /// Check if any output is configured.
    pub fn has_output(&self) -> bool {
        self.markdown_path.is_some() || self.json_path.is_some() || self.terminal_output
    }
}

/// Builder for OutputConfig.
#[derive(Debug, Clone, Default)]
pub struct OutputConfigBuilder {
    config: OutputConfig,
}

impl OutputConfigBuilder {
    /// Set markdown output path.
    pub fn markdown(mut self, path: impl Into<PathBuf>) -> Self {
        self.config.markdown_path = Some(path.into());
        self
    }

    /// Set JSON output path.
    pub fn json(mut self, path: impl Into<PathBuf>) -> Self {
        self.config.json_path = Some(path.into());
        self
    }

    /// Enable terminal output.
    pub fn terminal(mut self, enabled: bool) -> Self {
        self.config.terminal_output = enabled;
        self
    }

    /// Build the output config.
    pub fn build(self) -> OutputConfig {
        self.config
    }
}

// ============================================================================
// Output Result
// ============================================================================

/// Result of an output operation with metadata.
#[derive(Debug, Clone)]
pub struct OutputResult {
    /// Destination description.
    pub destination: String,

    /// Number of bytes written.
    pub bytes_written: usize,

    /// Time taken to write.
    pub duration: Duration,
}

// ============================================================================
// Output Format
// ============================================================================

/// Output format enumeration for render_to_string_effect.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum OutputFormat {
    /// Markdown format
    Markdown,
    /// JSON format
    Json,
    /// Terminal format (may lose colors)
    Terminal,
}

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

    #[test]
    fn test_output_config_builder() {
        let config = OutputConfig::builder()
            .markdown("report.md")
            .json("report.json")
            .terminal(true)
            .build();

        assert_eq!(config.markdown_path, Some(PathBuf::from("report.md")));
        assert_eq!(config.json_path, Some(PathBuf::from("report.json")));
        assert!(config.terminal_output);
        assert!(config.has_output());
    }

    #[test]
    fn test_output_config_has_output() {
        let empty_config = OutputConfig::default();
        assert!(!empty_config.has_output());

        let with_markdown = OutputConfig::builder().markdown("x.md").build();
        assert!(with_markdown.has_output());

        let with_terminal = OutputConfig::builder().terminal(true).build();
        assert!(with_terminal.has_output());
    }
}