use std::fmt::Write as _;
use std::io::{self, Write};
use jsonvet::{Problem, Report, Rule, Severity};
pub(crate) fn one_line(value: &str) -> String {
value.replace('\r', "\\r").replace('\n', "\\n")
}
fn escape(value: &str, property: bool) -> String {
let value = value
.replace('%', "%25")
.replace('\r', "%0D")
.replace('\n', "%0A");
if property {
value.replace(':', "%3A").replace(',', "%2C")
} else {
value
}
}
pub(crate) struct Printer<W: Write> {
pub(crate) out: W,
pub(crate) annotate: bool,
}
impl<W: Write> Printer<W> {
pub(crate) fn problem(
&mut self,
file: &str,
report: &Report<'_>,
problem: &Problem,
) -> io::Result<()> {
let at = report.location(problem.offset());
let mut message = problem.to_string();
if let Some(related) = problem.related_offset() {
let first = report.location(related);
let what = if problem.rule() == Rule::DuplicateKey {
"first at"
} else {
"started at"
};
let _ = write!(message, " ({what} {}:{})", first.line, first.column);
}
let severity = problem.severity();
let rule = problem.rule();
writeln!(
self.out,
"{}:{}:{}: {severity}[{rule}] {}",
one_line(file),
at.line,
at.column,
one_line(&message)
)?;
if self.annotate {
writeln!(
self.out,
"::{} file={},line={},col={},title=jsonvet ({rule})::{}",
annotation_level(severity),
escape(file, true),
at.line,
at.column,
escape(&message, false)
)?;
}
Ok(())
}
pub(crate) fn unreadable(&mut self, file: &str, message: &str) -> io::Result<()> {
writeln!(self.out, "{}: error: {}", one_line(file), one_line(message))?;
if self.annotate {
writeln!(
self.out,
"::error file={},title=jsonvet::{}",
escape(file, true),
escape(message, false)
)?;
}
Ok(())
}
}
fn annotation_level(severity: Severity) -> &'static str {
if severity == Severity::Error {
"error"
} else {
"warning"
}
}
#[cfg(test)]
mod tests {
use super::{escape, one_line};
#[test]
fn messages_stay_on_one_line_and_annotation_fields_are_percent_encoded() {
assert_eq!(one_line("a\n::warning::x"), "a\\n::warning::x");
assert_eq!(escape("50% a\r\nb", false), "50%25 a%0D%0Ab");
assert_eq!(escape("a:b,c", true), "a%3Ab%2Cc");
assert_eq!(escape("not strict: x, y", false), "not strict: x, y");
}
}