chore: move detekt to external project and migrate config to plugin (…

…AR-2904) (#1294)

* chore: move config to external proj ref

* chore: remove internal module

* chore: remove internal module

* chore: comments

* chore: refactor config detekt as plugin

* chore: refactor config detekt as plugin

* chore: refactor config detekt as plugin, comments

* chore: pr comments

build.gradle.kts

@@ -23,6 +23,8 @@ buildscript {
 }
 
 repositories {
+    mavenLocal()
+    wireDetektRulesRepo()
     google()
     mavenCentral()
 }
@@ -31,6 +33,7 @@ plugins {
     id("org.jetbrains.dokka")
     id("org.jetbrains.kotlinx.kover") version "0.5.1" // TODO(upgrade): Breaking changes in 0.6.0
     id("scripts.testing")
+    id("scripts.detekt")
 }
 
 dependencies {
@@ -45,9 +48,9 @@ tasks.withType<Test> {
 
 allprojects {
     repositories {
+        mavenLocal()
         google()
         mavenCentral()
-        mavenLocal()
         maven {
             url = uri("https://maven.pkg.github.com/wireapp/core-crypto")
             credentials {
@@ -89,5 +92,3 @@ rootProject.plugins.withType<org.jetbrains.kotlin.gradle.targets.js.nodejs.NodeJ
 }
 
 tasks.dokkaHtmlMultiModule.configure {}
-
-apply(from = "$rootDir/gradle/detekt.gradle")

buildSrc/build.gradle.kts

@@ -12,6 +12,7 @@ dependencies {
     implementation(libs.kotlin.plugin)
     implementation("org.jetbrains.dokka:dokka-gradle-plugin:${libs.versions.dokka.get()}")
     implementation("com.android.tools.build:gradle:${libs.versions.agp.get()}")
+    implementation("io.gitlab.arturbosch.detekt:detekt-gradle-plugin:${libs.versions.detekt.get()}")
 }
 
 gradlePlugin {

buildSrc/src/main/kotlin/ProjectExtensions.kt

@@ -1,5 +1,7 @@
 import org.codehaus.groovy.runtime.ProcessGroovyMethods
 import org.gradle.api.Project
+import org.gradle.api.artifacts.dsl.RepositoryHandler
+import org.gradle.kotlin.dsl.ivy
 import java.util.Properties
 import java.util.concurrent.TimeUnit
 
@@ -41,3 +43,21 @@ fun String.execute(): Process = ProcessGroovyMethods.execute(this).also {
  * Run command and return the output as text
  */
 fun Process.text(): String = ProcessGroovyMethods.getText(this)
+
+/**
+ * Configure the repository for wire's detekt custom rules
+ */
+fun RepositoryHandler.wireDetektRulesRepo() {
+    val repo = ivy("https://raw.githubusercontent.com/wireapp/wire-detekt-rules/main/dist") {
+        patternLayout {
+            artifact("/[module]-[revision].[ext]")
+        }
+        metadataSources.artifact()
+    }
+    exclusiveContent {
+        forRepositories(repo)
+        filter {
+            includeModule("com.wire", "detekt-rules")
+        }
+    }
+}

buildSrc/src/main/kotlin/scripts/detekt.gradle.kts

@@ -0,0 +1,48 @@
+package scripts
+
+import com.wire.kalium.plugins.libs
+import getLocalProperty
+import io.gitlab.arturbosch.detekt.Detekt
+
+plugins {
+    id("io.gitlab.arturbosch.detekt")
+}
+
+dependencies {
+    val detektVersion = libs.findVersion("detekt").get()
+    detekt("io.gitlab.arturbosch.detekt:detekt-cli:$detektVersion")
+    detektPlugins("io.gitlab.arturbosch.detekt:detekt-formatting:$detektVersion")
+    detektPlugins("com.wire:detekt-rules:1.0.0-SNAPSHOT") {
+        isChanging = true
+    }
+}
+
+detekt {
+    buildUponDefaultConfig = true
+    // activate all available (even unstable) rules.
+    // allRules = false
+    config = files("$rootDir/detekt/detekt.yml")
+    source = files("$rootDir")
+    // a way of suppressing issues before introducing detekt
+    baseline = file("$rootDir/detekt/baseline.xml")
+
+    // dynamic prop to enable and disable autocorrect, enabled locally via local.properties file
+    val autoFixEnabled = getLocalProperty("detektAutofix", "false")
+    autoCorrect = autoFixEnabled.toBoolean()
+    println("> Detekt autoCorrect: $autoFixEnabled")
+}
+
+tasks.withType<Detekt> {
+    reports.html.required.set(true) // observe findings in your browser with structure and code snippets
+    reports.xml.required.set(true)
+    reports.txt.required.set(false)
+
+    // general detekt ignore patterns of files, instead of by rule
+    exclude(
+        "buildSrc/**",
+        "**/build/**",
+        "**/test/**",
+        "**/*Test/**",
+        "**/protobuf/**",
+    )
+}

buildSrc/src/main/kotlin/scripts/testing.gradle.kts

@@ -5,6 +5,6 @@ import OnlyAffectedTestTask
 OnlyAffectedTestTask.TestTaskConfiguration.values().forEach {
     project.tasks.register(it.taskName, OnlyAffectedTestTask::class) {
         targetTestTask = it.testTarget
-        ignoredModules = mutableListOf("android", "detekt-rules", "protobuf", "protobuf-codegen")
+        ignoredModules = mutableListOf("android", "protobuf", "protobuf-codegen")
     }
 }