From 8a83fd12e697d72e6b082fe14c0e237a9efd2eaf Mon Sep 17 00:00:00 2001 From: Luke Date: Fri, 10 May 2024 18:13:13 +0200 Subject: [PATCH] Fix detekt --- plugin-build/CONTRIBUTING.md | 4 ++-- .../dev/iurysouza/modulegraph/gradle/ModuleGraphPlugin.kt | 7 ++++++- .../kotlin/dev/iurysouza/modulegraph/model/GraphConfig.kt | 3 +-- .../dev/iurysouza/modulegraph/model/GraphParseResult.kt | 2 +- .../test/java/dev/iurysouza/modulegraph/graph/Fixtures.kt | 1 + 5 files changed, 11 insertions(+), 6 deletions(-) diff --git a/plugin-build/CONTRIBUTING.md b/plugin-build/CONTRIBUTING.md index 25f07b3..cc1f327 100644 --- a/plugin-build/CONTRIBUTING.md +++ b/plugin-build/CONTRIBUTING.md @@ -1,8 +1,8 @@ This is the source for the Module Graph Gradle plugin. # Formatting -The code style of this project is enforced with Ktlint. Run it with: -`./gradlew :plugin-build:modulegraph:ktlintTestSourceSetCheck` +The code style of this project is enforced with Detekt. Run it with: +`./gradlew :plugin-build:modulegraph:detekt` # Test This project has extensive unit tests. Run them locally with: diff --git a/plugin-build/modulegraph/src/main/kotlin/dev/iurysouza/modulegraph/gradle/ModuleGraphPlugin.kt b/plugin-build/modulegraph/src/main/kotlin/dev/iurysouza/modulegraph/gradle/ModuleGraphPlugin.kt index 5c98357..61c5a5d 100644 --- a/plugin-build/modulegraph/src/main/kotlin/dev/iurysouza/modulegraph/gradle/ModuleGraphPlugin.kt +++ b/plugin-build/modulegraph/src/main/kotlin/dev/iurysouza/modulegraph/gradle/ModuleGraphPlugin.kt @@ -39,7 +39,12 @@ open class ModuleGraphPlugin : Plugin { val additionalGraphConfigs = task.graphConfigs.getOrElse(emptyList()) val allGraphConfigs = listOfNotNull(primaryGraphConfig) + additionalGraphConfigs if (allGraphConfigs.isEmpty()) { - error("No valid graph configs were found! Make sure to set up either the primary graph, or add additional graphs") + error( + """ + No valid graph configs were found! + Make sure to set up either the primary graph, or add additional graphs. + """.trimIndent(), + ) } val allProjects = project.allprojects diff --git a/plugin-build/modulegraph/src/main/kotlin/dev/iurysouza/modulegraph/model/GraphConfig.kt b/plugin-build/modulegraph/src/main/kotlin/dev/iurysouza/modulegraph/model/GraphConfig.kt index 65e9535..8c4c2ad 100644 --- a/plugin-build/modulegraph/src/main/kotlin/dev/iurysouza/modulegraph/model/GraphConfig.kt +++ b/plugin-build/modulegraph/src/main/kotlin/dev/iurysouza/modulegraph/model/GraphConfig.kt @@ -3,7 +3,6 @@ package dev.iurysouza.modulegraph.model import dev.iurysouza.modulegraph.LinkText import dev.iurysouza.modulegraph.Orientation import dev.iurysouza.modulegraph.Theme -import java.io.Serializable /** * The config for a single graph to be made. @@ -70,7 +69,7 @@ data class GraphConfig( * the generated graph will only include dependencies (direct and transitive) of root modules. */ val rootModulesRegex: String?, -) : Serializable { +) { class Builder( /** @see [GraphConfig.readmePath] */ diff --git a/plugin-build/modulegraph/src/main/kotlin/dev/iurysouza/modulegraph/model/GraphParseResult.kt b/plugin-build/modulegraph/src/main/kotlin/dev/iurysouza/modulegraph/model/GraphParseResult.kt index 7d48d1f..824bd77 100644 --- a/plugin-build/modulegraph/src/main/kotlin/dev/iurysouza/modulegraph/model/GraphParseResult.kt +++ b/plugin-build/modulegraph/src/main/kotlin/dev/iurysouza/modulegraph/model/GraphParseResult.kt @@ -8,4 +8,4 @@ internal data class GraphParseResult( val graph: ProjectGraph, /** The original config provided used to produce [graph] */ val config: GraphConfig, -) : Serializable +) diff --git a/plugin-build/modulegraph/src/test/java/dev/iurysouza/modulegraph/graph/Fixtures.kt b/plugin-build/modulegraph/src/test/java/dev/iurysouza/modulegraph/graph/Fixtures.kt index cda2bea..f82c737 100644 --- a/plugin-build/modulegraph/src/test/java/dev/iurysouza/modulegraph/graph/Fixtures.kt +++ b/plugin-build/modulegraph/src/test/java/dev/iurysouza/modulegraph/graph/Fixtures.kt @@ -71,6 +71,7 @@ internal val expectedMermaidGraphCode = """ |``` """.trimMargin() +@Suppress("LongParameterList") internal fun getConfig( readmePath: String = "", heading: String = "",