Create Rule Set For Libraries (#5360)

build-logic/src/main/kotlin/releasing.gradle.kts

@@ -40,6 +40,8 @@ project.afterEvaluate {
                 cliBuildDir.resolve("distributions/detekt-cli-${project.version}.zip"),
                 project(":detekt-formatting").buildDir.resolve("libs/detekt-formatting-${project.version}.jar"),
                 project(":detekt-generator").buildDir.resolve("libs/detekt-generator-${project.version}-all.jar"),
+                project(":detekt-rules-libraries").buildDir
+                    .resolve("libs/detekt-rules-libraries-${project.version}.jar"),
                 project(":detekt-rules-ruleauthors").buildDir
                     .resolve("libs/detekt-rules-ruleauthors-${project.version}.jar")
             )

build.gradle.kts

@@ -27,6 +27,7 @@ allprojects {
     dependencies {
         detekt(project(":detekt-cli"))
         detektPlugins(project(":detekt-formatting"))
+        detektPlugins(project(":detekt-rules-libraries"))
         detektPlugins(project(":detekt-rules-ruleauthors"))
     }
 

config/detekt/detekt.yml

@@ -190,10 +190,6 @@ style:
       - 'org.jetbrains.kotlin.diagnostics.DiagnosticUtils.getLineAndColumnInPsiFile'
   ForbiddenVoid:
     active: true
-  LibraryCodeMustSpecifyReturnType:
-    active: true
-    excludes: ['**/*.kt']
-    includes: ['**/detekt-api/src/main/**/api/*.kt']
   MagicNumber:
     excludes: ['**/test/**', '**/*Test.kt', '**/*Spec.kt']
     ignorePropertyDeclaration: true
@@ -271,3 +267,13 @@ style:
   WildcardImport:
     active: true
     excludeImports: []
+
+libraries:
+  ForbiddenPublicDataClass:
+    active: false
+  LibraryEntitiesShouldNotBePublic:
+    active: false
+  LibraryCodeMustSpecifyReturnType:
+    active: true
+    excludes: ['**/*.kt']
+    includes: ['**/detekt-api/src/main/**/api/*.kt']

detekt-cli/build.gradle.kts

@@ -8,7 +8,7 @@ application {
     mainClass.set("io.gitlab.arturbosch.detekt.cli.Main")
 }
 
-val formattingJar by configurations.creating {
+val pluginsJar: Configuration by configurations.creating {
     isTransitive = false
 }
 
@@ -27,7 +27,9 @@ dependencies {
     testImplementation(projects.detektTestUtils)
     testImplementation(libs.assertj)
 
-    formattingJar(projects.detektFormatting)
+    pluginsJar(projects.detektFormatting)
+    pluginsJar(projects.detektRulesLibraries)
+    pluginsJar(projects.detektRulesRuleauthors)
 }
 
 val javaComponent = components["java"] as AdhocComponentWithVariants
@@ -54,11 +56,11 @@ tasks {
 
     val runWithArgsFile by registering(JavaExec::class) {
         // The task generating these jar files run first.
-        inputs.files(formattingJar)
+        inputs.files(pluginsJar)
         doNotTrackState("The entire root directory is read as the input source.")
         classpath = files(shadowJar)
         workingDir = rootDir
-        args = listOf("@./config/detekt/argsfile", "-p", formattingJar.singleFile.path)
+        args = listOf("@./config/detekt/argsfile", "-p", pluginsJar.files.joinToString(",") { it.path })
     }
 
     check {

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

@@ -544,12 +544,6 @@ style:
         value: 'kotlin.io.print'
       - reason: 'println does not allow you to configure the output stream. Use a logger instead.'
         value: 'kotlin.io.println'
-  ForbiddenPublicDataClass:
-    active: true
-    excludes: ['**']
-    ignorePackages:
-      - '*.internal'
-      - '*.internal.*'
   ForbiddenSuppress:
     active: false
     rules: []
@@ -562,12 +556,6 @@ style:
     ignoreOverridableFunction: true
     ignoreActualFunction: true
     excludedFunctions: []
-  LibraryCodeMustSpecifyReturnType:
-    active: true
-    excludes: ['**']
-  LibraryEntitiesShouldNotBePublic:
-    active: true
-    excludes: ['**']
   LoopWithTooManyJumpStatements:
     active: true
     maxJumpCount: 1

detekt-core/src/main/resources/deprecation.properties

@@ -13,3 +13,6 @@ style>UnnecessaryAbstractClass>excludeAnnotatedClasses=Use `ignoreAnnotated` ins
 style>UseDataClass>excludeAnnotatedClasses=Use `ignoreAnnotated` instead
 formatting>Indentation>continuationIndentSize=`continuationIndentSize` is ignored by KtLint and will have no effect
 formatting>ParameterListWrapping>indentSize=`indentSize` is ignored by KtLint and will have no effect
+style>ForbiddenPublicDataClass=Rule migrated to `libraries` ruleset plugin
+style>LibraryCodeMustSpecifyReturnType=Rule migrated to `libraries` ruleset plugin
+style>LibraryEntitiesShouldNotBePublic=Rule migrated to `libraries` ruleset plugin

detekt-generator/build.gradle.kts

@@ -26,6 +26,7 @@ val cliOptionsFile = "${rootProject.rootDir}/website/docs/gettingstarted/_cli-op
 val defaultConfigFile = "$configDir/default-detekt-config.yml"
 val deprecationFile = "$configDir/deprecation.properties"
 val formattingConfigFile = "${rootProject.rootDir}/detekt-formatting/src/main/resources/config/config.yml"
+val librariesConfigFile = "${rootProject.rootDir}/detekt-rules-libraries/src/main/resources/config/config.yml"
 val ruleauthorsConfigFile = "${rootProject.rootDir}/detekt-rules-ruleauthors/src/main/resources/config/config.yml"
 
 val ruleModules = rootProject.subprojects
@@ -35,12 +36,19 @@ val ruleModules = rootProject.subprojects
     .map { "${rootProject.rootDir}/$it/src/main/kotlin" }
 
 val generateDocumentation by tasks.registering(JavaExec::class) {
-    dependsOn(tasks.assemble, ":detekt-api:dokkaHtml", tasks.shadowJar, ":detekt-rules-ruleauthors:sourcesJar")
+    dependsOn(
+        tasks.assemble,
+        tasks.shadowJar,
+        ":detekt-api:dokkaHtml",
+        ":detekt-rules-libraries:sourcesJar",
+        ":detekt-rules-ruleauthors:sourcesJar",
+    )
     description = "Generates detekt documentation and the default config.yml based on Rule KDoc"
     group = "documentation"
 
     inputs.files(
         ruleModules.map { fileTree(it) },
+        fileTree("${rootProject.rootDir}/detekt-rules-libraries/src/main/kotlin"),
         fileTree("${rootProject.rootDir}/detekt-rules-ruleauthors/src/main/kotlin"),
         fileTree("${rootProject.rootDir}/detekt-formatting/src/main/kotlin"),
         file("${rootProject.rootDir}/detekt-generator/build/libs/detekt-generator-${Versions.DETEKT}-all.jar"),
@@ -50,6 +58,7 @@ val generateDocumentation by tasks.registering(JavaExec::class) {
         fileTree(documentationDir),
         file(defaultConfigFile),
         file(formattingConfigFile),
+        file(librariesConfigFile),
         file(ruleauthorsConfigFile),
         file(deprecationFile),
         file(cliOptionsFile),
@@ -64,6 +73,7 @@ val generateDocumentation by tasks.registering(JavaExec::class) {
     args = listOf(
         "--input",
         ruleModules
+            .plus("${rootProject.rootDir}/detekt-rules-libraries/src/main/kotlin")
             .plus("${rootProject.rootDir}/detekt-rules-ruleauthors/src/main/kotlin")
             .plus("${rootProject.rootDir}/detekt-formatting/src/main/kotlin")
             .joinToString(","),

detekt-generator/src/main/kotlin/io/gitlab/arturbosch/detekt/generator/DetektPrinter.kt

@@ -24,7 +24,9 @@ class DetektPrinter(private val arguments: GeneratorArgs) {
             }
         }
         yamlWriter.write(arguments.configPath, "default-detekt-config") {
-            ConfigPrinter.print(pages.filterNot { it.ruleSet.name == "formatting" || it.ruleSet.name == "ruleauthors" })
+            ConfigPrinter.print(
+                pages.filterNot { it.ruleSet.name in listOf("formatting", "libraries", "ruleauthors") }
+            )
         }
         propertiesWriter.write(arguments.configPath, "deprecation") {
             // We intentionally not filter for "formatting" as we want to be able to deprecate
@@ -36,6 +38,11 @@ class DetektPrinter(private val arguments: GeneratorArgs) {
                 printRuleSetPage(pages.first { it.ruleSet.name == "formatting" })
             }
         }
+        yamlWriter.write(Paths.get("../detekt-rules-libraries/src/main/resources/config"), "config") {
+            yaml {
+                printRuleSetPage(pages.first { it.ruleSet.name == "libraries" })
+            }
+        }
         yamlWriter.write(Paths.get("../detekt-rules-ruleauthors/src/main/resources/config"), "config") {
             yaml {
                 printRuleSetPage(pages.first { it.ruleSet.name == "ruleauthors" })

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

@@ -11,7 +11,7 @@ object DeprecatedPrinter : DocumentationPrinter<List<RuleSetPage>> {
         item.forEach { ruleSet ->
             ruleSet.rules.forEach { rule ->
                 if (rule.isDeprecated()) {
-                    builder.appendLine(writeRuleProperty(ruleSet, rule))
+                    builder.appendLine(writeRule(ruleSet, rule))
                 }
                 rule.configuration.forEach { configuration ->
                     if (configuration.isDeprecated()) {
@@ -20,16 +20,25 @@ object DeprecatedPrinter : DocumentationPrinter<List<RuleSetPage>> {
                 }
             }
         }
+        builder.appendLine(writeMigratedRules())
         return builder.toString()
     }
 }
 
+private fun writeRule(ruleSet: RuleSetPage, rule: Rule): String {
+    @Suppress("UnsafeCallOnNullableType")
+    return "${ruleSet.ruleSet.name}>${rule.name}=${rule.deprecationMessage!!}"
+}
+
 private fun writeProperty(ruleSet: RuleSetPage, rule: Rule, configuration: Configuration): String {
     @Suppress("UnsafeCallOnNullableType")
     return "${ruleSet.ruleSet.name}>${rule.name}>${configuration.name}=${configuration.deprecated!!}"
 }
 
-private fun writeRuleProperty(ruleSet: RuleSetPage, rule: Rule): String {
-    @Suppress("UnsafeCallOnNullableType")
-    return "${ruleSet.ruleSet.name}>${rule.name}=${rule.deprecationMessage!!}"
+internal fun writeMigratedRules(): String {
+    return """
+        style>ForbiddenPublicDataClass=Rule migrated to `libraries` ruleset plugin
+        style>LibraryCodeMustSpecifyReturnType=Rule migrated to `libraries` ruleset plugin
+        style>LibraryEntitiesShouldNotBePublic=Rule migrated to `libraries` ruleset plugin
+    """.trimIndent()
 }

detekt-generator/src/main/kotlin/io/gitlab/arturbosch/detekt/generator/printer/defaultconfig/Exclusion.kt

@@ -5,7 +5,7 @@ import io.gitlab.arturbosch.detekt.generator.collection.Rule
 /**
  * Holds a list of extra exclusions for rules and rule sets.
  */
-val exclusions = arrayOf(TestExclusions, KotlinScriptExclusions, KotlinScriptAndTestExclusions, LibraryExclusions)
+val exclusions = arrayOf(TestExclusions, KotlinScriptExclusions, KotlinScriptAndTestExclusions)
 
 /**
  * Tracks rules and rule sets which needs an extra `excludes: $pattern` property
@@ -56,13 +56,3 @@ private object KotlinScriptAndTestExclusions : Exclusions() {
             "'**/*.kts']"
     override val rules = setOf("MagicNumber")
 }
-
-private object LibraryExclusions : Exclusions() {
-
-    override val pattern = "['**']"
-    override val rules = setOf(
-        "ForbiddenPublicDataClass",
-        "LibraryCodeMustSpecifyReturnType",
-        "LibraryEntitiesShouldNotBePublic",
-    )
-}

detekt-generator/src/test/kotlin/io/gitlab/arturbosch/detekt/generator/printer/DeprecatedPrinterSpec.kt

@@ -13,8 +13,7 @@ class DeprecatedPrinterSpec {
             style>MagicNumber>conf2=use conf1 instead
             style>MagicNumber>conf4=use conf3 instead
             style>DuplicateCaseInWhenExpression=is deprecated
-
-        """.trimIndent()
+        """.trimIndent() + "\n${writeMigratedRules()}\n"
         assertThat(markdownString).isEqualTo(expectedMarkdownString)
     }
 }

detekt-rules-libraries/build.gradle.kts

@@ -0,0 +1,9 @@
+plugins {
+    id("module")
+}
+
+dependencies {
+    compileOnly(projects.detektApi)
+    testImplementation(projects.detektTest)
+    testImplementation(libs.assertj)
+}

detekt-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenPublicDataClass.kt → detekt-rules-libraries/src/main/kotlin/io/gitlab/arturbosch/detekt/libraries/ForbiddenPublicDataClass.kt

@@ -1,4 +1,4 @@
-package io.gitlab.arturbosch.detekt.rules.style
+package io.gitlab.arturbosch.detekt.libraries
 
 import io.gitlab.arturbosch.detekt.api.CodeSmell
 import io.gitlab.arturbosch.detekt.api.Config

detekt-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/LibraryCodeMustSpecifyReturnType.kt → detekt-rules-libraries/src/main/kotlin/io/gitlab/arturbosch/detekt/libraries/LibraryCodeMustSpecifyReturnType.kt

@@ -1,4 +1,4 @@
-package io.gitlab.arturbosch.detekt.rules.style
+package io.gitlab.arturbosch.detekt.libraries
 
 import io.gitlab.arturbosch.detekt.api.CodeSmell
 import io.gitlab.arturbosch.detekt.api.Config

detekt-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/LibraryEntitiesShouldNotBePublic.kt → detekt-rules-libraries/src/main/kotlin/io/gitlab/arturbosch/detekt/libraries/LibraryEntitiesShouldNotBePublic.kt

@@ -1,4 +1,4 @@
-package io.gitlab.arturbosch.detekt.rules.style
+package io.gitlab.arturbosch.detekt.libraries
 
 import io.gitlab.arturbosch.detekt.api.CodeSmell
 import io.gitlab.arturbosch.detekt.api.Config

detekt-rules-libraries/src/main/kotlin/io/gitlab/arturbosch/detekt/libraries/RuleLibrariesProvider.kt

@@ -0,0 +1,24 @@
+package io.gitlab.arturbosch.detekt.libraries
+
+import io.gitlab.arturbosch.detekt.api.Config
+import io.gitlab.arturbosch.detekt.api.RuleSet
+import io.gitlab.arturbosch.detekt.api.RuleSetProvider
+import io.gitlab.arturbosch.detekt.api.internal.ActiveByDefault
+
+/**
+ * Rules in this rule set report issues related to libraries API exposure.
+ */
+@ActiveByDefault("1.16.0")
+class RuleLibrariesProvider : RuleSetProvider {
+
+    override val ruleSetId: String = "libraries"
+
+    override fun instance(config: Config) = RuleSet(
+        ruleSetId,
+        listOf(
+            ForbiddenPublicDataClass(config),
+            LibraryEntitiesShouldNotBePublic(config),
+            LibraryCodeMustSpecifyReturnType(config),
+        )
+    )
+}

detekt-rules-libraries/src/main/resources/META-INF/services/io.gitlab.arturbosch.detekt.api.RuleSetProvider

@@ -0,0 +1 @@
+io.gitlab.arturbosch.detekt.libraries.RuleLibrariesProvider

detekt-rules-libraries/src/main/resources/config/config.yml

@@ -0,0 +1,11 @@
+libraries:
+  active: true
+  ForbiddenPublicDataClass:
+    active: true
+    ignorePackages:
+      - '*.internal'
+      - '*.internal.*'
+  LibraryCodeMustSpecifyReturnType:
+    active: true
+  LibraryEntitiesShouldNotBePublic:
+    active: true

detekt-rules-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenPublicDataClassSpec.kt → detekt-rules-libraries/src/test/kotlin/io/gitlab/arturbosch/detekt/libraries/ForbiddenPublicDataClassSpec.kt

@@ -1,4 +1,4 @@
-package io.gitlab.arturbosch.detekt.rules.style
+package io.gitlab.arturbosch.detekt.libraries
 
 import io.gitlab.arturbosch.detekt.api.Config
 import io.gitlab.arturbosch.detekt.test.TestConfig

detekt-rules-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/LibraryCodeMustSpecifyReturnTypeSpec.kt → detekt-rules-libraries/src/test/kotlin/io/gitlab/arturbosch/detekt/libraries/LibraryCodeMustSpecifyReturnTypeSpec.kt

@@ -1,4 +1,4 @@
-package io.gitlab.arturbosch.detekt.rules.style
+package io.gitlab.arturbosch.detekt.libraries
 
 import io.gitlab.arturbosch.detekt.api.Config
 import io.gitlab.arturbosch.detekt.rules.KotlinCoreEnvironmentTest

detekt-rules-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/LibraryEntitiesShouldNotBePublicSpec.kt → detekt-rules-libraries/src/test/kotlin/io/gitlab/arturbosch/detekt/libraries/LibraryEntitiesShouldNotBePublicSpec.kt

@@ -1,4 +1,4 @@
-package io.gitlab.arturbosch.detekt.rules.style
+package io.gitlab.arturbosch.detekt.libraries
 
 import io.gitlab.arturbosch.detekt.api.Config
 import io.gitlab.arturbosch.detekt.test.TestConfig

detekt-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/StyleGuideProvider.kt

@@ -41,7 +41,6 @@ class StyleGuideProvider : DefaultRuleSetProvider {
             ForbiddenComment(config),
             ForbiddenImport(config),
             ForbiddenMethodCall(config),
-            ForbiddenPublicDataClass(config),
             ForbiddenSuppress(config),
             FunctionOnlyReturningConstant(config),
             SpacingBetweenPackageAndImports(config),
@@ -89,8 +88,6 @@ class StyleGuideProvider : DefaultRuleSetProvider {
             UseCheckOrError(config),
             UseIfInsteadOfWhen(config),
             RedundantExplicitType(config),
-            LibraryEntitiesShouldNotBePublic(config),
-            LibraryCodeMustSpecifyReturnType(config),
             UseArrayLiteralsInAnnotations(config),
             UseEmptyCounterpart(config),
             UseCheckNotNull(config),

settings.gradle.kts

@@ -28,6 +28,7 @@ include("detekt-rules-documentation")
 include("detekt-rules-empty")
 include("detekt-rules-errorprone")
 include("detekt-rules-exceptions")
+include("detekt-rules-libraries")
 include("detekt-rules-naming")
 include("detekt-rules-performance")
 include("detekt-rules-ruleauthors")