jbuild 0.1.8

High-performance Java build tool supporting Maven and Gradle
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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

//! Output formatters for Checkstyle-rs

use crate::checkstyle::api::violation::Violation;
use std::io::Write;

/// Trait for formatting output
pub trait OutputFormatter: Send + Sync {
    /// Format a violation
    fn format_violation(&self, violation: &Violation, file_name: &str) -> String;

    /// Write violations to a writer
    fn write_violations<W: Write>(
        &self,
        writer: &mut W,
        violations: &[(String, Vec<Violation>)],
    ) -> std::io::Result<()>;
}

/// Plain text formatter (default Checkstyle format)
pub struct PlainFormatter;

impl PlainFormatter {
    pub fn new() -> Self {
        Self
    }
}

impl Default for PlainFormatter {
    fn default() -> Self {
        Self::new()
    }
}

impl OutputFormatter for PlainFormatter {
    fn format_violation(&self, violation: &Violation, file_name: &str) -> String {
        let severity_str = match violation.severity_level {
            crate::checkstyle::api::event::SeverityLevel::Warning => "WARN",
            crate::checkstyle::api::event::SeverityLevel::Error => "ERROR",
            crate::checkstyle::api::event::SeverityLevel::Info => "INFO",
            crate::checkstyle::api::event::SeverityLevel::Ignore => "IGNORE",
        };

        if violation.column_no > 0 {
            format!(
                "[{}] {}:{}:{}: {} [{}]",
                severity_str,
                file_name,
                violation.line_no,
                violation.column_no,
                violation.get_message(),
                violation.module_id
            )
        } else {
            format!(
                "[{}] {}:{}: {} [{}]",
                severity_str,
                file_name,
                violation.line_no,
                violation.get_message(),
                violation.module_id
            )
        }
    }

    fn write_violations<W: Write>(
        &self,
        writer: &mut W,
        violations: &[(String, Vec<Violation>)],
    ) -> std::io::Result<()> {
        for (file_name, file_violations) in violations {
            for violation in file_violations {
                if violation.severity_level != crate::checkstyle::api::event::SeverityLevel::Ignore {
                    writeln!(writer, "{}", self.format_violation(violation, file_name))?;
                }
            }
        }
        Ok(())
    }
}

/// XML formatter
pub struct XmlFormatter;

impl XmlFormatter {
    pub fn new() -> Self {
        Self
    }
}

impl Default for XmlFormatter {
    fn default() -> Self {
        Self::new()
    }
}

impl OutputFormatter for XmlFormatter {
    fn format_violation(&self, violation: &Violation, _file_name: &str) -> String {
        format!(
            r#"<error line="{}" column="{}" severity="{}" message="{}" source="{}"/>"#,
            violation.line_no,
            violation.column_no,
            match violation.severity_level {
                crate::checkstyle::api::event::SeverityLevel::Warning => "warning",
                crate::checkstyle::api::event::SeverityLevel::Error => "error",
                crate::checkstyle::api::event::SeverityLevel::Info => "info",
                crate::checkstyle::api::event::SeverityLevel::Ignore => "ignore",
            },
            xml_escape(&violation.get_message()),
            xml_escape(&violation.module_id)
        )
    }

    fn write_violations<W: Write>(
        &self,
        writer: &mut W,
        violations: &[(String, Vec<Violation>)],
    ) -> std::io::Result<()> {
        writeln!(writer, r#"<?xml version="1.0" encoding="UTF-8"?>"#)?;
        writeln!(writer, r#"<checkstyle version="checkstyle-rs">"#)?;

        for (file_name, file_violations) in violations {
            if !file_violations.is_empty() {
                writeln!(writer, r#"  <file name="{}">"#, xml_escape(file_name))?;
                for violation in file_violations {
                    if violation.severity_level != crate::checkstyle::api::event::SeverityLevel::Ignore {
                        writeln!(
                            writer,
                            "    {}",
                            self.format_violation(violation, file_name)
                        )?;
                    }
                }
                writeln!(writer, r#"  </file>"#)?;
            }
        }

        writeln!(writer, r#"</checkstyle>"#)?;
        Ok(())
    }
}

/// Escape XML special characters
fn xml_escape(s: &str) -> String {
    s.replace('&', "&amp;")
        .replace('<', "&lt;")
        .replace('>', "&gt;")
        .replace('"', "&quot;")
        .replace('\'', "&apos;")
}