Migrate buildSrc to composite build (#4090)

This will help reduce build times when changes are made to the precompiled
script plugins used in the build. This is because a change in buildSrc
causes the whole project to become out-of-date [0]. Using an included build
instead works around this problem.

[0] https://docs.gradle.org/7.2/userguide/organizing_gradle_projects.html#sec:build_sources

README.md

@@ -43,7 +43,7 @@ Visit [the project website](https://detekt.github.io/detekt/) for installation g
 - [Suppressing issues via baseline file](https://detekt.github.io/detekt/baseline.html)
 - [Configuring detekt](https://detekt.github.io/detekt/configurations.html)
 - Sample Gradle integrations examples:
-    - [multi project (Kotlin DSL) with precompiled script plugin](https://github.com/detekt/detekt/blob/main/buildSrc/src/main/kotlin/detekt.gradle.kts)
+    - [multi project (Kotlin DSL) with precompiled script plugin](https://github.com/detekt/detekt/blob/main/build-logic/src/main/kotlin/detekt.gradle.kts)
     - [single project (Groovy DSL)](https://github.com/arturbosch/kutils/blob/main/build.gradle)
     - [single project (Unofficial Maven plugin)](https://github.com/detekt/sonar-kotlin/blob/main/pom.xml)
     - [setup additional detekt task for all modules (Kotlin DSL)](https://github.com/detekt/detekt/blob/3357abba87e1550c65b6610012bb291e0fbb64ce/build.gradle.kts#L280-L295)

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

@@ -32,7 +32,7 @@ project.afterEvaluate {
 }
 
 fun updateVersion(increment: (Semver) -> Semver) {
-    val versionsFile = file("${rootProject.rootDir}/buildSrc/src/main/kotlin/Versions.kt")
+    val versionsFile = file("${rootProject.rootDir}/build-logic/src/main/kotlin/Versions.kt")
     val newContent = versionsFile.readLines()
         .joinToString("\n") {
             if (it.contains("const val DETEKT: String")) {

build.gradle.kts

@@ -2,9 +2,9 @@ import io.gitlab.arturbosch.detekt.Detekt
 import io.gitlab.arturbosch.detekt.DetektCreateBaselineTask
 
 plugins {
-    packaging
-    releasing
-    detekt
+    id("packaging")
+    id("releasing")
+    id("detekt")
     alias(libs.plugins.gradleVersionz)
     alias(libs.plugins.sonarqube)
 }

config/detekt/argsfile

@@ -3,7 +3,7 @@
 -b
 ./config/detekt/baseline.xml
 -ex
-**/resources/**,**/detekt*/build/**,**/buildSrc/build/**
+**/resources/**,**/detekt*/build/**,**/build-logic/build/**
 --build-upon-default-config
 -c
 ./config/detekt/detekt.yml

config/detekt/detekt.yml

@@ -107,7 +107,7 @@ formatting:
 naming:
   InvalidPackageDeclaration:
     active: true
-    excludes: ['**/buildSrc/**/*.kt', '**/*.kts']
+    excludes: ['**/build-logic/**/*.kt', '**/*.kts']
   NoNameShadowing:
     active: true
   NonBooleanPropertyPrefixedWithIs:

custom-checks/build.gradle.kts

@@ -1,5 +1,5 @@
 plugins {
-    module
+    id("module")
 }
 
 dependencies {

detekt-api/build.gradle.kts

@@ -1,7 +1,7 @@
 import org.jetbrains.dokka.gradle.DokkaTask
 
 plugins {
-    module
+    id("module")
     alias(libs.plugins.dokka)
     `java-test-fixtures`
     alias(libs.plugins.binaryCompatibilityValidator)

detekt-cli/build.gradle.kts

@@ -1,6 +1,6 @@
 plugins {
     alias(libs.plugins.shadow)
-    module
+    id("module")
     application
 }
 

detekt-core/build.gradle.kts

@@ -1,5 +1,5 @@
 plugins {
-    module
+    id("module")
 }
 
 dependencies {

detekt-formatting/build.gradle.kts

@@ -1,5 +1,5 @@
 plugins {
-    module
+    id("module")
 }
 
 dependencies {

detekt-generator/build.gradle.kts

@@ -1,7 +1,7 @@
 import java.io.ByteArrayOutputStream
 
 plugins {
-    module
+    id("module")
 }
 
 dependencies {

detekt-gradle-plugin/build.gradle.kts

@@ -1,5 +1,5 @@
 plugins {
-    module
+    id("module")
     `java-gradle-plugin`
     alias(libs.plugins.pluginPublishing)
 }

detekt-metrics/build.gradle.kts

@@ -1,5 +1,5 @@
 plugins {
-    module
+    id("module")
 }
 
 dependencies {

detekt-parser/build.gradle.kts

@@ -1,7 +1,7 @@
 import org.jetbrains.kotlin.gradle.plugin.getKotlinPluginVersion
 
 plugins {
-    module
+    id("module")
 }
 
 dependencies {

detekt-psi-utils/build.gradle.kts

@@ -1,5 +1,5 @@
 plugins {
-    module
+    id("module")
     alias(libs.plugins.binaryCompatibilityValidator)
 }
 

detekt-report-html/build.gradle.kts

@@ -1,5 +1,5 @@
 plugins {
-    module
+    id("module")
 }
 
 dependencies {

detekt-report-sarif/build.gradle.kts

@@ -1,5 +1,5 @@
 plugins {
-    module
+    id("module")
 }
 
 dependencies {

detekt-report-txt/build.gradle.kts

@@ -1,5 +1,5 @@
 plugins {
-    module
+    id("module")
 }
 
 dependencies {

detekt-report-xml/build.gradle.kts

@@ -1,5 +1,5 @@
 plugins {
-    module
+    id("module")
 }
 
 dependencies {

detekt-rules-complexity/build.gradle.kts

@@ -1,5 +1,5 @@
 plugins {
-    module
+    id("module")
 }
 
 dependencies {

detekt-rules-coroutines/build.gradle.kts

@@ -1,5 +1,5 @@
 plugins {
-    module
+    id("module")
 }
 
 dependencies {

detekt-rules-documentation/build.gradle.kts

@@ -1,5 +1,5 @@
 plugins {
-    module
+    id("module")
 }
 
 dependencies {

detekt-rules-empty/build.gradle.kts

@@ -1,5 +1,5 @@
 plugins {
-    module
+    id("module")
 }
 
 dependencies {

detekt-rules-errorprone/build.gradle.kts

@@ -1,5 +1,5 @@
 plugins {
-    module
+    id("module")
 }
 
 dependencies {

detekt-rules-exceptions/build.gradle.kts

@@ -1,5 +1,5 @@
 plugins {
-    module
+    id("module")
 }
 
 dependencies {

detekt-rules-naming/build.gradle.kts

@@ -1,5 +1,5 @@
 plugins {
-    module
+    id("module")
 }
 
 dependencies {

detekt-rules-performance/build.gradle.kts

@@ -1,5 +1,5 @@
 plugins {
-    module
+    id("module")
 }
 
 dependencies {

detekt-rules-style/build.gradle.kts

@@ -1,5 +1,5 @@
 plugins {
-    module
+    id("module")
 }
 
 dependencies {

detekt-rules/build.gradle.kts

@@ -1,5 +1,5 @@
 plugins {
-    module
+    id("module")
 }
 
 dependencies {

detekt-sample-extensions/build.gradle.kts

@@ -1,5 +1,5 @@
 plugins {
-    module
+    id("module")
 }
 
 dependencies {

detekt-test-utils/build.gradle.kts

@@ -1,5 +1,5 @@
 plugins {
-    module
+    id("module")
 }
 
 dependencies {

detekt-test/build.gradle.kts

@@ -1,5 +1,5 @@
 plugins {
-    module
+    id("module")
 }
 
 dependencies {

detekt-tooling/build.gradle.kts

@@ -1,5 +1,5 @@
 plugins {
-    module
+    id("module")
 }
 
 dependencies {

settings.gradle.kts

@@ -1,4 +1,9 @@
 rootProject.name = "detekt"
+
+pluginManagement {
+    includeBuild("build-logic")
+}
+
 include(
     "code-coverage-report",
     "custom-checks",