Merge pull request #516 from abs-paradigm/feature/sarif-reporter

Added support for sarif reporter

Author: Tapchicoma

CHANGELOG.md

@@ -7,7 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 
 ## [10.2.0-SNAPSHOT] - Unreleased
 ### Added
-  - ?
+  - sarif reporter to provided reporters
 
 ### Changed
   - Update Gradle to `7.1.1` version

README.md

@@ -272,7 +272,8 @@ ktlint {
     reporters {
         reporter "plain"
         reporter "checkstyle"
-        
+        reporter "sarif"
+
         customReporters {
             "csv" {
                 fileExtension = "csv"

plugin/src/main/kotlin/org/jlleitschuh/gradle/ktlint/KtlintExtension.kt

@@ -160,7 +160,7 @@ internal constructor(
          *
          * _By default_ `plain` type is enabled if no reporter is explicitly specified.
          *
-         * @param reporterType one of `plain`, `plain_group_by_file`, `checkstyle`, `json`.
+         * @param reporterType one of `plain`, `plain_group_by_file`, `checkstyle`, `json`, `sarif`.
          */
         fun reporter(reporterType: ReporterType) {
             reporters.add(reporterType)

plugin/src/main/kotlin/org/jlleitschuh/gradle/ktlint/reporter/ReporterType.kt

@@ -13,6 +13,7 @@ enum class ReporterType(
     PLAIN_GROUP_BY_FILE("plain", SemVer(0, 9, 0), "txt", listOf("group_by_file")),
     CHECKSTYLE("checkstyle", SemVer(0, 9, 0), "xml", emptyList()),
     JSON("json", SemVer(0, 9, 0), "json", emptyList()),
+    SARIF("sarif", SemVer(0, 42, 0), "sarif", emptyList()),
     HTML("html", SemVer(0, 36, 0), "html", emptyList());
 
     companion object {

plugin/src/test/kotlin/org/jlleitschuh/gradle/ktlint/ReportersTest.kt

@@ -186,6 +186,28 @@ class ReportersTest : AbstractPluginTest() {
         }
     }
 
+    @DisplayName("Should generate sarif report")
+    @CommonTest
+    internal fun sarifReport(gradleVersion: GradleVersion) {
+        project(gradleVersion) {
+            withCleanSources()
+            //language=Groovy
+            buildGradle.appendText(
+                """
+
+                ktlint.reporters {
+                    reporter "sarif"
+                }
+                """.trimIndent()
+            )
+
+            build(CHECK_PARENT_TASK_NAME) {
+                assertThat(task(":$mainSourceSetCheckTaskName")?.outcome).isEqualTo(TaskOutcome.SUCCESS)
+                assertReportCreated(ReporterType.SARIF.fileExtension, mainSourceSetCheckTaskName)
+            }
+        }
+    }
+
     @DisplayName("Should ignore html reporter on KtLint versions less then 0.36.0")
     @CommonTest
     @DisabledOnOs(OS.WINDOWS)