Files
SwiftLint/Source/SwiftLintFramework/Reporters/SonarQubeReporter.swift
Danny Mösch a6c4fd98bc Move files from SwiftLintCore to SwiftLintFramework
Ideally, SwiftLintCore would some day only contain components
that are needed to define rules. Consequently, it would be the
only bundle required to import for (external) rule development.
2024-12-23 12:51:43 +01:00

34 lines
1.1 KiB
Swift

import SourceKittenFramework
/// Reports violations in SonarQube import format.
struct SonarQubeReporter: Reporter {
// MARK: - Reporter Conformance
static let identifier = "sonarqube"
static let isRealtime = false
static let description = "Reports violations in SonarQube import format."
static func generateReport(_ violations: [StyleViolation]) -> String {
toJSON(["issues": violations.map(dictionary(for:))])
}
// MARK: - Private
// refer to https://docs.sonarqube.org/display/SONAR/Generic+Issue+Data
private static func dictionary(for violation: StyleViolation) -> [String: Any] {
[
"engineId": "SwiftLint",
"ruleId": violation.ruleIdentifier,
"primaryLocation": [
"message": violation.reason,
"filePath": violation.location.relativeFile ?? "",
"textRange": [
"startLine": violation.location.line ?? 1
] as Any,
] as Any,
"type": "CODE_SMELL",
"severity": violation.severity == .error ? "MAJOR" : "MINOR",
]
}
}