ANDROID-11179 detekt implementation

.github/workflows/tests.yml

@@ -20,7 +20,7 @@ jobs:
         uses: actions/checkout@v2
 
       - name: "Build Android project"
-        run: 'bash ./gradlew clean check assemble'
+        run: 'bash ./gradlew clean check detekt assemble'
 
       - name: Upload Lint results
         uses: github/codeql-action/upload-sarif@v2

README.md

@@ -2,7 +2,7 @@
 ![Mistica for Android](doc/images/mistica-android-dark.svg#gh-dark-mode-only)
 
 [![Platform](https://img.shields.io/badge/Platform-Android-brightgreen)](https://github.com/Telefonica/mistica-android)
-[![Version](https://maven-badges.herokuapp.com/maven-central/com.telefonica/mistica/badge.png)](https://search.maven.org/artifact/com.telefonica/mistica)
+[![Version](https://img.shields.io/maven-metadata/v.svg?label=maven-central&metadataUrl=https%3A%2F%2Frepo1.maven.org%2Fmaven2%2Fcom%2Ftelefonica%2Fmistica%2Fmaven-metadata.xml)](https://search.maven.org/artifact/com.telefonica/mistica)
 [![Support](https://img.shields.io/badge/Support-%3E%3D%20Android%205.0-brightgreen)](https://github.com/Telefonica/mistica-android)
 [![Kotlin version badge](https://img.shields.io/badge/kotlin-1.8.20-blue.svg)](https://kotlinlang.org/docs/whatsnew1820.html)
 

build-tools/detekt.gradle

@@ -0,0 +1,6 @@
+
+detekt {
+    buildUponDefaultConfig = true
+    config.from(files("$projectDir/build-tools/detekt/detekt.yml"))
+    basePath = files("$projectDir")
+}

build-tools/detekt/detekt.yml

@@ -0,0 +1,36 @@
+complexity:
+  TooManyFunctions:
+    active: false
+  LongParameterList:
+    active: false
+
+style:
+  NewLineAtEndOfFile:
+    active: false
+  MagicNumber:
+    active: false
+  ReturnCount:
+    active: false
+  UnusedImports:
+    active: true
+  MaxLineLength:
+    maxLineLength: 160
+  UnusedPrivateMember:
+    ignoreAnnotated: 'Preview'
+  UnnecessaryAbstractClass:
+    ignoreAnnotated: "Module"
+
+naming:
+  FunctionNaming:
+    active: true
+    ignoreAnnotated: 'Composable'
+
+empty-blocks:
+  EmptyFunctionBlock:
+    active: false
+
+exceptions:
+  TooGenericExceptionThrown:
+    active: false
+  TooGenericExceptionCaught:
+    active: false

build.gradle

@@ -11,6 +11,7 @@ buildscript {
         accompanist_version = "0.32.0"
         coil_version = '2.5.0'
         constraintComposeVersion = '1.0.1'
+        detekt_version = '1.23.7'
         roborazzi_version = "1.10.1"
     }
     repositories {
@@ -23,13 +24,19 @@ buildscript {
         classpath "com.android.tools.build:gradle:8.1.4"
         classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
         classpath "gradle.plugin.com.betomorrow.gradle:appcenter-plugin:2.0.3"
+        classpath "io.gitlab.arturbosch.detekt:detekt-gradle-plugin:$detekt_version"
     }
 }
 
 plugins {
     id 'org.jetbrains.kotlin.android' version '1.5.21' apply false
     id 'io.github.gradle-nexus.publish-plugin' version '1.1.0' apply false
     id "io.github.takahirom.roborazzi" version '1.10.1' apply false
+    id "io.gitlab.arturbosch.detekt" version '1.23.7'
+}
+
+dependencies {
+    apply plugin: "io.gitlab.arturbosch.detekt"
 }
 
 allprojects {
@@ -41,10 +48,47 @@ allprojects {
         version = System.getProperty("LIBRARY_VERSION") ?: "undefined"
     }
 
+    tasks.withType(io.gitlab.arturbosch.detekt.Detekt).all {
+        exclude("build/")
+        exclude("**/build/**")
+        exclude("**/resources/**")
+        exclude("**/tmp/**")
+        exclude("**/*Autogenerated.kt")
+    }
+
+    tasks.withType(io.gitlab.arturbosch.detekt.Detekt).configureEach {
+        reports {
+            html {
+                outputLocation.set(file("$buildDir/reports/detekt/detekt-report.html"))
+                required.set(true)
+            }
+            xml {
+                outputLocation.set(file("$buildDir/reports/detekt/detekt-checkstyle.xml"))
+                required.set(true)
+            }
+        }
+    }
+
+    task detektProjectBaseline(type: io.gitlab.arturbosch.detekt.DetektCreateBaselineTask) {
+        description = "Overrides current baseline."
+        ignoreFailures.set(true)
+        parallel.set(true)
+        buildUponDefaultConfig.set(true)
+        setSource(files("$projectDir"))
+        config.setFrom(files("$projectDir/build-tools/detekt/detekt.yml"))
+        include("**/*.kt")
+        include("**/*.kts")
+    }
+
     repositories {
         google()
         mavenCentral()
     }
 }
 
 apply from: "${rootProject.projectDir}/publish_maven_central.gradle"
+apply from: "build-tools/detekt.gradle"
+
+tasks.withType(io.gitlab.arturbosch.detekt.Detekt) {
+    autoCorrect = true
+}