improve formatting of console report

group rule summaries by source class

Author: wakingrufus

nebula-archrules-gradle-plugin/gradle.lockfile

@@ -4,10 +4,10 @@
 cglib:cglib-nodep:3.2.2=testRuntimeClasspath
 com.fasterxml.jackson.core:jackson-annotations:2.20=compileClasspath,runtimeClasspath,testCompileClasspath,testRuntimeClasspath
 com.jayway.jsonpath:json-path:2.9.0=testCompileClasspath,testRuntimeClasspath
-com.netflix.nebula:archrules-deprecation:0.1.3=archRules
-com.netflix.nebula:archrules-joda:0.1.3=archRules
-com.netflix.nebula:archrules-testing-frameworks:0.1.3=archRules
-com.netflix.nebula:nebula-archrules-core:0.1.5=archRules
+com.netflix.nebula:archrules-deprecation:0.3.0=archRules
+com.netflix.nebula:archrules-joda:0.3.0=archRules
+com.netflix.nebula:archrules-testing-frameworks:0.3.0=archRules
+com.netflix.nebula:nebula-archrules-core:0.2.3=archRules
 com.netflix.nebula:nebula-test:11.9.0=testCompileClasspath,testRuntimeClasspath
 com.tngtech.archunit:archunit:1.4.1=archRules,compileClasspath,runtimeClasspath,testCompileClasspath,testRuntimeClasspath
 net.bytebuddy:byte-buddy:1.17.7=testCompileClasspath,testRuntimeClasspath
@@ -39,7 +39,7 @@ org.jetbrains.kotlin:kotlin-stdlib:2.2.0=compileClasspath,kotlinBuildToolsApiCla
 org.jetbrains.kotlinx:kotlinx-coroutines-core-jvm:1.8.0=kotlinBuildToolsApiClasspath,kotlinCompilerClasspath
 org.jetbrains:annotations:13.0=compileClasspath,kotlinBuildToolsApiClasspath,kotlinCompilerClasspath,kotlinCompilerPluginClasspathMain,kotlinCompilerPluginClasspathTest,testCompileClasspath,testRuntimeClasspath
 org.json:json:20250517=testCompileClasspath,testRuntimeClasspath
-org.jspecify:jspecify:1.0.0=testCompileClasspath,testRuntimeClasspath
+org.jspecify:jspecify:1.0.0=archRules,testCompileClasspath,testRuntimeClasspath
 org.junit.jupiter:junit-jupiter-api:5.14.1=testCompileClasspath,testRuntimeClasspath
 org.junit.jupiter:junit-jupiter-engine:5.14.1=testRuntimeClasspath
 org.junit.jupiter:junit-jupiter-params:5.14.1=testCompileClasspath,testRuntimeClasspath

nebula-archrules-gradle-plugin/src/main/java/com/netflix/nebula/archrules/gradle/PrintConsoleReportTask.java

@@ -28,19 +28,16 @@ abstract public class PrintConsoleReportTask extends DefaultTask {
     @TaskAction
     public void printReport() {
         final var consoleOutput = getServices().get(StyledTextOutputFactory.class).create("archrules");
-        consoleOutput.style(StyledTextOutput.Style.Header).println("ArchRule summary:").println();
         List<RuleResult> list = getDataFiles().get().stream()
                 .flatMap(it -> ViolationsUtil.readDetails(it).stream())
                 .toList();
         final var byRule = ViolationsUtil.consolidatedFailures(list);
         ViolationsUtil.printSummary(byRule, consoleOutput);
-        consoleOutput.println();
         if (list.stream().anyMatch(it -> it.status() != RuleResultStatus.FAIL && it.rule().priority() == Priority.LOW) && !getLogger().isInfoEnabled()) {
             consoleOutput.style(StyledTextOutput.Style.Header)
                     .text("Note: ")
                     .style(StyledTextOutput.Style.Normal)
-                    .println("In order to see details of LOW priority rules, run build with --info")
-                    .println();
+                    .println("In order to see details of LOW priority rules, run build with --info");
         }
         ViolationsUtil.printReport(byRule, consoleOutput, getLogger().isInfoEnabled());
     }

nebula-archrules-gradle-plugin/src/main/kotlin/com/netflix/nebula/archrules/gradle/ViolationsUtil.kt

@@ -56,27 +56,34 @@ class ViolationsUtil {
 
         @JvmStatic
         fun printSummary(resultMap: Map<Rule, List<RuleResult>>, output: StyledTextOutput) {
+            val indent = 4
             val maxRuleNameLength = resultMap.keys.maxOfOrNull { it.ruleName().length } ?: 1
-            resultMap.forEach { (rule, results) ->
-                val failures = results.filter { it.status() != RuleResultStatus.PASS }
-                if (failures.isEmpty()) {
-                    output.style(StyledTextOutput.Style.Success)
-                        .text(rule.ruleName().padEnd(maxRuleNameLength + 1))
-                        .text(" ")
-                        .text(rule.priority().asString().padEnd(10))
-                        .println(" (No failures)")
-                } else {
-                    val style = when (rule.priority()) {
-                        Priority.LOW -> StyledTextOutput.Style.Normal
-                        Priority.MEDIUM -> StyledTextOutput.Style.Info
-                        Priority.HIGH -> StyledTextOutput.Style.Failure
+            resultMap.entries.groupBy { entry -> entry.key.ruleClass() }
+                .forEach { (ruleClass, classMap) ->
+                    output.style(StyledTextOutput.Style.Header).println(ruleClass)
+                    classMap.forEach { (rule, results) ->
+                        val failures = results.filter { it.status() != RuleResultStatus.PASS }
+                        if (failures.isEmpty()) {
+                            output.style(StyledTextOutput.Style.Success)
+                                .text(" ".repeat(indent))
+                                .text(rule.ruleName().padEnd(maxRuleNameLength + 1))
+                                .text(" ")
+                                .text(rule.priority().asString().padEnd(10))
+                                .println(" (No failures)")
+                        } else {
+                            val style = when (rule.priority()) {
+                                Priority.LOW -> StyledTextOutput.Style.Normal
+                                Priority.MEDIUM -> StyledTextOutput.Style.Info
+                                Priority.HIGH -> StyledTextOutput.Style.Failure
+                            }
+                            output.style(style)
+                                .text(" ".repeat(indent))
+                                .text(rule.ruleName().padEnd(maxRuleNameLength + 1))
+                                .text(" ")
+                                .text(rule.priority().asString().padEnd(10))
+                                .println(" (" + failures.size + " failures)")
+                        }
                     }
-                    output.style(style)
-                        .text(rule.ruleName().padEnd(maxRuleNameLength + 1))
-                        .text(" ")
-                        .text(rule.priority().asString().padEnd(10))
-                        .println(" (" + failures.size + " failures)")
-                }
             }
         }
 

nebula-archrules-gradle-plugin/src/test/kotlin/com/netflix/nebula/archrules/gradle/ArchrulesRunnerPluginTest.kt

@@ -120,7 +120,7 @@ class ArchrulesRunnerPluginTest {
             .exists()
 
         assertThat(result.output)
-            .contains("ArchRule summary:")
+            .contains("com.netflix.nebula.archrules.deprecation.DeprecationRule")
             .contains("deprecated  LOW        (1 failures)")
     }