35 lines
1.2 KiB
Swift
35 lines
1.2 KiB
Swift
/// Reports violations with relative paths.
|
|
public struct RelativePathReporter: Reporter {
|
|
// MARK: - Reporter Conformance
|
|
|
|
public static let identifier = "relative-path"
|
|
public static let isRealtime = true
|
|
|
|
public var description: String {
|
|
return "Reports violations with relative paths."
|
|
}
|
|
|
|
public static func generateReport(_ violations: [StyleViolation]) -> String {
|
|
return violations.map(generateForSingleViolation).joined(separator: "\n")
|
|
}
|
|
|
|
/// Generates a report for a single violation.
|
|
///
|
|
/// - parameter violation: The violation to report.
|
|
///
|
|
/// - returns: The report for a single violation.
|
|
internal static func generateForSingleViolation(_ violation: StyleViolation) -> String {
|
|
// {relative_path_to_file}{:line}{:character}: {error,warning}: {content}
|
|
|
|
return [
|
|
"\(violation.location.relativeFile ?? "<nopath>")",
|
|
":\(violation.location.line ?? 1)",
|
|
":\(violation.location.character ?? 1): ",
|
|
"\(violation.severity.rawValue): ",
|
|
"\(violation.ruleName) Violation: ",
|
|
violation.reason,
|
|
" (\(violation.ruleIdentifier))"
|
|
].joined()
|
|
}
|
|
}
|