Merge pull request #58 from rubensousa/report_config

Add option to configure report

Author: rubensousa

README.md

@@ -133,6 +133,18 @@ projectGuard {
 - `./gradlew projectGuardCheck`: Runs the dependency analysis on individual modules and generates a html report under `module/build/reports/projectguard/index.html`.
 - `./gradlew projectGuardBaseline`: Creates a `projectguard-baseline.yml` file with all current restrictions. This allows you to start enforcing rules on new code without having to fix all existing issues first.
 
+
+## Report configuration options
+
+```kotlin
+projectGuard {
+    report {
+        // Default is false. When true, libraries are displayed in the dependency graph section
+        showLibrariesInGraph = true
+    }
+}
+```
+
 ## License
 
     Copyright 2026 Rúben Sousa

projectguard/api/projectguard.api

@@ -38,6 +38,7 @@ public abstract class com/rubensousa/projectguard/plugin/ProjectGuardExtension :
 	public fun <init> (Lorg/gradle/api/model/ObjectFactory;)V
 	public fun guard (Ljava/lang/String;Lorg/gradle/api/Action;)V
 	public fun guardRule (Lorg/gradle/api/Action;)Lcom/rubensousa/projectguard/plugin/GuardRule;
+	public fun report (Lorg/gradle/api/Action;)V
 	public fun restrictDependency (Ljava/lang/String;Lorg/gradle/api/Action;)V
 	public fun restrictDependency (Lorg/gradle/api/provider/Provider;Lorg/gradle/api/Action;)V
 	public fun restrictDependencyRule (Lorg/gradle/api/Action;)Lcom/rubensousa/projectguard/plugin/RestrictDependencyRule;
@@ -55,6 +56,8 @@ public abstract interface class com/rubensousa/projectguard/plugin/ProjectGuardS
 	public abstract fun guard (Ljava/lang/String;Lorg/gradle/api/Action;)V
 	public fun guard (Lorg/gradle/api/internal/catalog/DelegatingProjectDependency;Lorg/gradle/api/Action;)V
 	public abstract fun guardRule (Lorg/gradle/api/Action;)Lcom/rubensousa/projectguard/plugin/GuardRule;
+	public fun report (Lgroovy/lang/Closure;)V
+	public abstract fun report (Lorg/gradle/api/Action;)V
 	public fun restrictDependency (Ljava/lang/String;Lgroovy/lang/Closure;)V
 	public abstract fun restrictDependency (Ljava/lang/String;Lorg/gradle/api/Action;)V
 	public fun restrictDependency (Lorg/gradle/api/internal/catalog/DelegatingProjectDependency;Lorg/gradle/api/Action;)V
@@ -72,6 +75,11 @@ public abstract interface class com/rubensousa/projectguard/plugin/ProjectGuardS
 	public abstract fun restrictModuleRule (Lorg/gradle/api/Action;)Lcom/rubensousa/projectguard/plugin/RestrictModuleRule;
 }
 
+public abstract interface class com/rubensousa/projectguard/plugin/ReportScope {
+	public abstract fun getShowLibrariesInGraph ()Z
+	public abstract fun setShowLibrariesInGraph (Z)V
+}
+
 public final class com/rubensousa/projectguard/plugin/RestrictDependencyRule {
 }
 

projectguard/src/main/kotlin/com/rubensousa/projectguard/plugin/ProjectGuardExtension.kt

@@ -23,10 +23,11 @@ import com.rubensousa.projectguard.plugin.internal.GuardSpec
 import com.rubensousa.projectguard.plugin.internal.ModuleRestrictionScopeImpl
 import com.rubensousa.projectguard.plugin.internal.ModuleRestrictionSpec
 import com.rubensousa.projectguard.plugin.internal.ProjectGuardSpec
+import com.rubensousa.projectguard.plugin.internal.ReportScopeImpl
+import com.rubensousa.projectguard.plugin.internal.ReportSpec
 import com.rubensousa.projectguard.plugin.internal.getDependencyPath
 import org.gradle.api.Action
 import org.gradle.api.artifacts.MinimalExternalModuleDependency
-import org.gradle.api.internal.catalog.DelegatingProjectDependency
 import org.gradle.api.model.ObjectFactory
 import org.gradle.api.provider.Provider
 import org.gradle.kotlin.dsl.listProperty
@@ -39,6 +40,7 @@ abstract class ProjectGuardExtension @Inject constructor(
     private val guardSpecs = objects.listProperty<GuardSpec>()
     private val moduleRestrictionSpecs = objects.listProperty<ModuleRestrictionSpec>()
     private val dependencyRestrictionSpecs = objects.listProperty<DependencyRestrictionSpec>()
+    private var reportSpec = ReportSpec(showLibrariesInGraph = false)
 
     override fun restrictModule(modulePath: String, action: Action<ModuleRestrictionScope>) {
         val scope = ModuleRestrictionScopeImpl()
@@ -117,11 +119,20 @@ abstract class ProjectGuardExtension @Inject constructor(
         return rule
     }
 
+    override fun report(action: Action<ReportScope>) {
+        val scope = ReportScopeImpl()
+        action.execute(scope)
+        reportSpec = reportSpec.copy(
+            showLibrariesInGraph = scope.showLibrariesInGraph
+        )
+    }
+
     internal fun getSpec(): ProjectGuardSpec {
         return ProjectGuardSpec(
             guardSpecs = guardSpecs.get(),
             moduleRestrictionSpecs = moduleRestrictionSpecs.get(),
-            dependencyRestrictionSpecs = dependencyRestrictionSpecs.get()
+            dependencyRestrictionSpecs = dependencyRestrictionSpecs.get(),
+            reportSpec = reportSpec
         )
     }
 

projectguard/src/main/kotlin/com/rubensousa/projectguard/plugin/ProjectGuardPlugin.kt

@@ -61,7 +61,7 @@ class ProjectGuardPlugin : Plugin<Project> {
             return
         }
         val extension = getExtension(rootProject)
-        val aggregationTasks = createAggregationTasks(rootProject)
+        val aggregationTasks = createAggregationTasks(rootProject, extension)
         val individualModuleTasks = mutableListOf<ModuleTasks>()
         rootProject.subprojects.forEach { targetProject ->
             val moduleTasks = createModuleTasks(
@@ -166,13 +166,14 @@ class ProjectGuardPlugin : Plugin<Project> {
 
     private fun createAggregationTasks(
         rootProject: Project,
+        extension: ProjectGuardExtension,
     ): AggregationTasks {
         return AggregationTasks(
             dependencyDump = createAggregateDependencyDumpTask(rootProject),
             restrictionDump = createAggregateRestrictionTask(rootProject),
             baselineDump = createBaselineTask(rootProject),
             baselineCreate = createBaselineReferenceTask(rootProject),
-            check = createAggregateCheckTask(rootProject)
+            check = createAggregateCheckTask(rootProject, extension)
         )
     }
 
@@ -233,30 +234,38 @@ class ProjectGuardPlugin : Plugin<Project> {
         extension: ProjectGuardExtension,
     ): ModuleTasks {
         return ModuleTasks(
-            check = createCheckTask(targetProject),
+            check = createCheckTask(targetProject, extension),
             restrictionDump = createModuleRestrictionTask(targetProject, extension),
             dependencyDump = createDependencyDumpTask(targetProject)
         )
     }
 
-    private fun createCheckTask(project: Project): TaskProvider<TaskCheck> {
+    private fun createCheckTask(
+        project: Project,
+        extension: ProjectGuardExtension,
+    ): TaskProvider<TaskCheck> {
         return project.tasks.register(
             "projectGuardCheck",
             TaskCheck::class.java
         ) {
             group = "verification"
             description = "Verifies if there are any dependency restrictions"
+            reportSpec.set(extension.getSpec().reportSpec)
             outputs.upToDateWhen { false }
         }
     }
 
-    private fun createAggregateCheckTask(project: Project): TaskProvider<TaskCheck> {
+    private fun createAggregateCheckTask(
+        project: Project,
+        extension: ProjectGuardExtension,
+    ): TaskProvider<TaskCheck> {
         return project.tasks.register(
             "projectGuardAggregateCheck",
             TaskCheck::class.java
         ) {
             group = "verification"
             description = "Verifies if there are any dependency restrictions"
+            reportSpec.set(extension.getSpec().reportSpec)
             outputs.upToDateWhen { false }
         }
     }

projectguard/src/main/kotlin/com/rubensousa/projectguard/plugin/ProjectGuardScope.kt

@@ -72,7 +72,7 @@ interface ProjectGuardScope {
      */
     fun restrictModule(
         moduleDelegation: DelegatingProjectDependency,
-        action: Action<ModuleRestrictionScope> = Action<ModuleRestrictionScope> { }
+        action: Action<ModuleRestrictionScope> = Action<ModuleRestrictionScope> { },
     ) = restrictModule(modulePath = moduleDelegation.path, action = action)
 
     // Just here for groovy support
@@ -122,7 +122,7 @@ interface ProjectGuardScope {
      */
     fun guard(
         moduleDelegation: DelegatingProjectDependency,
-        action: Action<GuardScope>
+        action: Action<GuardScope>,
     ) = guard(modulePath = moduleDelegation.path, action = action)
 
     /**
@@ -167,7 +167,7 @@ interface ProjectGuardScope {
      */
     fun restrictDependency(
         dependencyDelegation: DelegatingProjectDependency,
-        action: Action<DependencyRestrictionScope> = Action<DependencyRestrictionScope> { }
+        action: Action<DependencyRestrictionScope> = Action<DependencyRestrictionScope> { },
     ) = restrictDependency(dependencyPath = dependencyDelegation.path, action = action)
 
     /**
@@ -188,16 +188,23 @@ interface ProjectGuardScope {
     // Just here for groovy support
     fun restrictDependency(
         dependencyPath: String,
-        closure: Closure<DependencyRestrictionScope>
+        closure: Closure<DependencyRestrictionScope>,
     ) {
         restrictDependency(dependencyPath, ConfigureUtil.configureUsing(closure))
     }
 
     // Just here for groovy support
     fun restrictDependency(
         provider: Provider<MinimalExternalModuleDependency>,
-        closure: Closure<DependencyRestrictionScope>
+        closure: Closure<DependencyRestrictionScope>,
     ) {
         restrictDependency(provider, ConfigureUtil.configureUsing(closure))
     }
+
+    fun report(action: Action<ReportScope>)
+
+    fun report(closure: Closure<ReportScope>) {
+        report(ConfigureUtil.configureUsing(closure))
+    }
+
 }

projectguard/src/main/kotlin/com/rubensousa/projectguard/plugin/ReportScope.kt

@@ -0,0 +1,21 @@
+/*
+ * Copyright 2026 Rúben Sousa
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.rubensousa.projectguard.plugin
+
+interface ReportScope {
+    var showLibrariesInGraph: Boolean
+}

projectguard/src/main/kotlin/com/rubensousa/projectguard/plugin/internal/ProjectGuardSpec.kt

@@ -22,4 +22,5 @@ internal data class ProjectGuardSpec(
     val guardSpecs: List<GuardSpec>,
     val moduleRestrictionSpecs: List<ModuleRestrictionSpec>,
     val dependencyRestrictionSpecs: List<DependencyRestrictionSpec>,
+    val reportSpec: ReportSpec,
 ) : Serializable

projectguard/src/main/kotlin/com/rubensousa/projectguard/plugin/internal/ReportScopeImpl.kt

@@ -0,0 +1,25 @@
+/*
+ * Copyright 2026 Rúben Sousa
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.rubensousa.projectguard.plugin.internal
+
+import com.rubensousa.projectguard.plugin.ReportScope
+
+internal class ReportScopeImpl : ReportScope {
+
+    override var showLibrariesInGraph: Boolean = false
+
+}

projectguard/src/main/kotlin/com/rubensousa/projectguard/plugin/internal/ReportSpec.kt

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2026 Rúben Sousa
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.rubensousa.projectguard.plugin.internal
+
+import java.io.Serializable
+
+internal data class ReportSpec(
+    val showLibrariesInGraph: Boolean,
+) : Serializable

projectguard/src/main/kotlin/com/rubensousa/projectguard/plugin/internal/report/VerificationReportBuilder.kt

@@ -17,16 +17,27 @@
 package com.rubensousa.projectguard.plugin.internal.report
 
 import com.rubensousa.projectguard.plugin.internal.DependencyConfiguration
+import com.rubensousa.projectguard.plugin.internal.ReportSpec
 import com.rubensousa.projectguard.plugin.internal.SuppressionMap
 
 internal class VerificationReportBuilder(
     private val suppressionMap: SuppressionMap,
+    private val reportSpec: ReportSpec,
 ) {
 
     fun build(
         dependencyGraphDump: DependencyGraphDump,
         restrictionDump: RestrictionDump,
     ): VerificationReport {
+        return VerificationReport(
+            modules = buildVerificationReports(restrictionDump),
+            dependencyGraph = buildDependencyGraph(dependencyGraphDump)
+        )
+    }
+
+    private fun buildVerificationReports(
+        restrictionDump: RestrictionDump,
+    ): List<VerificationModuleReport> {
         val totalFatalMatches = mutableMapOf<String, MutableList<FatalMatch>>()
         val totalSuppressedMatches = mutableMapOf<String, MutableList<SuppressedMatch>>()
         val reports = mutableSetOf<String>()
@@ -63,30 +74,39 @@ internal class VerificationReportBuilder(
                 reports.add(moduleReport.module)
             }
         }
-        val sortedReports = reports.sortedBy { it }
+        return reports.sorted()
             .map { moduleId ->
                 VerificationModuleReport(
                     module = moduleId,
                     fatal = totalFatalMatches[moduleId]?.sortedBy { it.dependency } ?: emptyList(),
                     suppressed = totalSuppressedMatches[moduleId]?.sortedBy { it.dependency } ?: emptyList(),
                 )
             }
+    }
+
+    private fun buildDependencyGraph(
+        dependencyGraphDump: DependencyGraphDump,
+    ): Map<String, List<DependencyReferenceDump>> {
         val graph = mutableMapOf<String, MutableSet<DependencyReferenceDump>>()
         dependencyGraphDump.modules.forEach { report ->
             report.configurations.forEach { configuration ->
                 // TODO: Until https://github.com/rubensousa/ProjectGuard/issues/3 is clarified,
                 //  filter out test dependencies from the graph reports
                 val moduleDependencies = graph.getOrPut(report.module) { mutableSetOf() }
                 if (DependencyConfiguration.isReleaseConfiguration(configuration.id)) {
-                    moduleDependencies.addAll(configuration.dependencies.map { dependency ->
-                        DependencyReferenceDump(dependency.id, dependency.isLibrary)
+                    moduleDependencies.addAll(configuration.dependencies.mapNotNull { dependency ->
+                        if (reportSpec.showLibrariesInGraph || !dependency.isLibrary) {
+                            DependencyReferenceDump(dependency.id, dependency.isLibrary)
+                        } else {
+                            null
+                        }
                     })
                 }
             }
         }
-        return VerificationReport(sortedReports, graph.mapValues { entry ->
+        return graph.mapValues { entry ->
             entry.value.sortedBy { it.id }
-        })
+        }
     }
 
 }