Merge pull request #54 from nimblehq/chore/update-detekt-config-readm…

…e-gradle

Update detekt Config, README, gradle version etc...

README.md

@@ -1,3 +1,27 @@
 ![Build Status](https://www.bitrise.io/app/4cbfc6308f5c80e5/status.svg?token=FXilfAPD1nT8M1QzlfBNqA&branch=kotlin)
 # Android Templates: Kotlin
-- Our optimized Android templates used in our kotlin android projects
+- Our optimized Android templates used in our kotlin android projects
+
+### Setup
+- Clone the project
+- Checkout our main development branch `kotlin`
+- Run the project with Android Studio
+
+
+### Linter and static code analysis
+
+1. Check Style:
+
+```
+$ ./gradlew checkStyle
+```
+
+Report is located at: `./app/build/reports/checkstyle/`
+
+2. Detekt
+
+```
+$ ./gradlew detekt
+```
+
+Report is located at: `./build/reports/detekt.html`

build.gradle

@@ -62,7 +62,7 @@ buildscript {
 }
 
 plugins {
-    id "io.gitlab.arturbosch.detekt" version "1.0.0.RC6-3"
+    id "io.gitlab.arturbosch.detekt" version "1.14.0"
 }
 
 allprojects {
@@ -79,12 +79,28 @@ task clean(type: Delete) {
 }
 
 detekt {
-    profile("main") {
-        input = "$projectDir"
-        config = "$project.rootDir/detekt-config.yml"
-        filters = ".*test.*,.*/resources/.*,.*/tmp/.*"
-        output = "${project.buildDir}/reports/detekt/"
-        parallel = true
-        disableDefaultRuleSets = false
+    toolVersion = "1.14.0"
+
+    input = files("app/src/main/java", "app/src/main/kotlin", "data/src/main/kotlin", "data/src/main/java")
+    parallel = false
+    config = files("detekt-config.yml")
+    buildUponDefaultConfig = false
+    disableDefaultRuleSets = false
+
+    debug = false
+    ignoreFailures = false
+
+    ignoredBuildTypes = ["release"]
+    ignoredFlavors = ["production"]
+
+    reports {
+        xml {
+            enabled = true
+            destination = file("build/reports/detekt.xml")
+        }
+        html {
+            enabled = true
+            destination = file("build/reports/detekt.html")
+        }
     }
 }

detekt-config.yml

@@ -1,24 +1,3 @@
-autoCorrect: true
-failFast: false
-
-test-pattern: # Configure exclusions for test sources
-  active: true
-  patterns: # Test file regexes
-    - '.*/test/.*'
-    - '.*Test.kt'
-    - '.*Spec.kt'
-  exclude-rule-sets:
-    - 'comments'
-  exclude-rules:
-    - 'NamingRules'
-    - 'WildcardImport'
-    - 'MagicNumber'
-    - 'MaxLineLength'
-    - 'LateinitUsage'
-    - 'StringLiteralDuplication'
-    - 'SpreadOperator'
-    - 'TooManyFunctions'
-
 build:
   maxIssues: 10
   weights:
@@ -172,7 +151,7 @@ exceptions:
     active: false
   TooGenericExceptionCaught:
     active: true
-    exceptions:
+    exceptionNames:
      - ArrayIndexOutOfBoundsException
      - Error
      - Exception
@@ -183,7 +162,7 @@ exceptions:
      - Throwable
   TooGenericExceptionThrown:
     active: true
-    exceptions:
+    exceptionNames:
      - Error
      - Exception
      - NullPointerException
@@ -326,8 +305,6 @@ style:
     active: false
   OptionalAbstractKeyword:
     active: true
-  OptionalReturnKeyword:
-    active: false
   OptionalUnit:
     active: false
   OptionalWhenBraces: