Add a new ConsoleReport format

detekt-core/src/main/kotlin/io/gitlab/arturbosch/detekt/core/reporting/console/ReadableFindingsReport.kt

@@ -0,0 +1,35 @@
+package io.gitlab.arturbosch.detekt.core.reporting.console
+
+import io.gitlab.arturbosch.detekt.api.Config
+import io.gitlab.arturbosch.detekt.api.ConsoleReport
+import io.gitlab.arturbosch.detekt.api.Detektion
+import io.gitlab.arturbosch.detekt.api.SingleAssign
+import io.gitlab.arturbosch.detekt.core.reporting.filterEmptyIssues
+
+/**
+ * Contains a clear read of the console report, where each line contains location, messages and issue id.
+ * See: https://detekt.github.io/detekt/configurations.html#console-reports
+ */
+class ReadableFindingsReport : ConsoleReport() {
+
+    private var config: Config by SingleAssign()
+
+    override val priority: Int = 40
+
+    override fun init(config: Config) {
+        this.config = config
+    }
+
+    override fun render(detektion: Detektion): String? {
+        val issues = detektion.filterEmptyIssues(config)
+        if (issues.isEmpty()) {
+            return null
+        }
+        return buildString {
+            issues.values.flatten().forEach { finding ->
+                append("${finding.location.compact()}: ${finding.messageOrDescription()} [${finding.issue.id}]")
+                appendLine()
+            }
+        }
+    }
+}

detekt-core/src/main/resources/META-INF/services/io.gitlab.arturbosch.detekt.api.ConsoleReport

@@ -1,5 +1,6 @@
 io.gitlab.arturbosch.detekt.core.reporting.console.ComplexityReport
 io.gitlab.arturbosch.detekt.core.reporting.console.FindingsReport
 io.gitlab.arturbosch.detekt.core.reporting.console.FileBasedFindingsReport
+io.gitlab.arturbosch.detekt.core.reporting.console.ReadableFindingsReport
 io.gitlab.arturbosch.detekt.core.reporting.console.NotificationReport
 io.gitlab.arturbosch.detekt.core.reporting.console.ProjectStatisticsReport

detekt-core/src/main/resources/default-detekt-config.yml

@@ -38,6 +38,7 @@ console-reports:
      - 'NotificationReport'
   #  - 'FindingsReport'
      - 'FileBasedFindingsReport'
+     - 'ReadableFindingsReport'
 
 output-reports:
   active: true

detekt-core/src/test/kotlin/io/gitlab/arturbosch/detekt/core/reporting/console/ReadableFindingsReportSpec.kt

@@ -0,0 +1,53 @@
+package io.gitlab.arturbosch.detekt.core.reporting.console
+
+import io.github.detekt.test.utils.readResourceContent
+import io.gitlab.arturbosch.detekt.api.Config
+import io.gitlab.arturbosch.detekt.api.Finding
+import io.gitlab.arturbosch.detekt.core.reporting.AutoCorrectableIssueAssert
+import io.gitlab.arturbosch.detekt.test.TestDetektion
+import io.gitlab.arturbosch.detekt.test.createFinding
+import org.assertj.core.api.Assertions.assertThat
+import org.spekframework.spek2.Spek
+import org.spekframework.spek2.style.specification.describe
+
+class ReadableFindingsReportSpec : Spek({
+
+    val subject by memoized { createFindingsReport() }
+
+    describe("findings report") {
+        it("reports non-empty findings") {
+            assertThat(
+                subject
+                    .render(
+                        TestDetektion(
+                            createFinding("SpacingBetweenPackageAndImports"),
+                            createFinding("UnnecessarySafeCall")
+                        )
+                    )
+            ).isEqualTo(readResourceContent("/reporting/readable-findings-report.txt"))
+        }
+
+        it("reports no findings") {
+            val detektion = TestDetektion()
+            assertThat(subject.render(detektion)).isNull()
+        }
+
+        it("reports no findings with rule set containing no smells") {
+            val detektion = object : TestDetektion() {
+                override val findings: Map<String, List<Finding>> = mapOf(
+                    Pair("Ruleset", emptyList())
+                )
+            }
+            assertThat(subject.render(detektion)).isNull()
+        }
+
+        it("should not add auto corrected issues to report") {
+            val report = FindingsReport()
+            AutoCorrectableIssueAssert.isReportNull(report)
+        }
+    }
+})
+
+private fun createFindingsReport() = ReadableFindingsReport().apply {
+    init(Config.empty)
+}

detekt-core/src/test/resources/reporting/readable-findings-report.txt

@@ -0,0 +1,2 @@
+TestFile.kt:1:1: TestMessage [SpacingBetweenPackageAndImports]
+TestFile.kt:1:1: TestMessage [UnnecessarySafeCall]

detekt-generator/src/main/kotlin/io/gitlab/arturbosch/detekt/generator/printer/rulesetpage/ConfigPrinter.kt

@@ -116,6 +116,7 @@ object ConfigPrinter : DocumentationPrinter<List<RuleSetPage>> {
            - 'NotificationReport'
         #  - 'FindingsReport'
            - 'FileBasedFindingsReport'
+           - 'ReadableFindingsReport'
     """.trimIndent()
 
     private fun defaultOutputReportsConfiguration(): String = """

docs/pages/configurations.md

@@ -98,6 +98,7 @@ console-reports:
   #  - 'NotificationReport'
   #  - 'FindingsReport'
   #  - 'FileBasedFindingsReport'
+  #  - 'ReadableFindingsReport'
 ```
 
 **ProjectStatisticsReport** contains metrics and statistics concerning the analyzed project sorted by priority.