Add Ktlint as code formatter (#1405)

* Added ktlint config

* Remove detekt

Author: aballano

.editorconfig

@@ -0,0 +1,5 @@
+# Some KtLint rules
+[*.{kt,kts}]
+indent_size=2
+insert_final_newline=true
+max_line_length=off

build.gradle

@@ -21,8 +21,8 @@ buildscript {
         // Constants
         ankKotlinVersion = '1.3.11'
         daggerVersion = '2.21'
-        detekt_version = '1.0.0-RC12'
         dokka_version = '0.9.18'
+        ktlint_version = '7.3.0'
         gradleVersionsPluginVersion = '0.21.0'
         jUnitVersion = '4.12'
         jUnitVintageVersion = '5.4.0'
@@ -55,7 +55,7 @@ buildscript {
         classpath 'org.ajoberstar:gradle-git-publish:2.0.0'
         classpath "net.rdrei.android.buildtimetracker:gradle-plugin:0.11.1"
         classpath "org.jetbrains.dokka:dokka-gradle-plugin:$dokka_version"
-        classpath "io.gitlab.arturbosch.detekt:detekt-gradle-plugin:$detekt_version"
+        classpath "org.jlleitschuh.gradle:ktlint-gradle:$ktlint_version"
     }
 }
 
@@ -86,7 +86,7 @@ subprojects { project ->
     apply plugin: 'kotlin'
     apply plugin: 'jacoco'
     apply plugin: 'org.jetbrains.dokka'
-    apply plugin: 'io.gitlab.arturbosch.detekt'
+    apply plugin: "org.jlleitschuh.gradle.ktlint"
 
     archivesBaseName = POM_ARTIFACT_ID
 
@@ -118,13 +118,6 @@ subprojects { project ->
 
     }
 
-    detekt {
-        toolVersion = detekt_version
-        input = files("src/main/java", "src/main/kotlin", "src/test/kotlin")
-        parallel = true
-        config = files("${rootProject.projectDir}/detekt.yml")
-    }
-
     task codeCoverageReport(type: JacocoReport) {
         reports {
             xml.enabled true

detekt.yml

@@ -6,4 +6,5 @@ import java.io.File
 data class AnkExtension(
   var source: File? = null,
   var target: File? = null,
-  var classpath: FileCollection? = null)
+  var classpath: FileCollection? = null
+)

modules/ank/arrow-ank-gradle/src/main/kotlin/arrow/ank/AnkExtension.kt

@@ -26,4 +26,4 @@ class AnkPlugin : Plugin<Project> {
       )
     }
   }
-}
+}

modules/ank/arrow-ank-gradle/src/main/kotlin/arrow/ank/AnkPlugin.kt

@@ -25,5 +25,4 @@ interface AnkOps {
   suspend fun generateFile(path: Path, newContent: Sequence<String>): Path
 
   suspend fun printConsole(msg: String): Unit
-
-}
+}

modules/ank/arrow-ank/src/main/kotlin/arrow/ank/algebra.kt

@@ -40,8 +40,7 @@ fun <F> Fx<F>.ank(source: Path, target: Path, compilerArgs: List<String>, ankOps
       }.toList().sequence()
     }
 
-
     val message = "Ank Processed ${paths.size} files"
     !effect { printConsole(colored(ANSI_GREEN, message)) }
   }
-}
+}

modules/ank/arrow-ank/src/main/kotlin/arrow/ank/ank.kt

@@ -32,7 +32,7 @@ const val ANSI_CYAN = "\u001B[36m"
 const val ANSI_WHITE = "\u001B[37m"
 
 fun colored(color: String, message: String) =
-  "$color$message${ANSI_RESET}"
+  "$color$message$ANSI_RESET"
 
 val AnkHeader =
   """

modules/ank/arrow-ank/src/main/kotlin/arrow/ank/formatter.kt

@@ -1,6 +1,13 @@
 package arrow.ank
 
-import arrow.core.*
+import arrow.core.None
+import arrow.core.Option
+import arrow.core.Some
+import arrow.core.Try
+import arrow.core.Tuple2
+import arrow.core.Tuple3
+import arrow.core.some
+import arrow.core.toT
 import arrow.data.extensions.sequence.foldable.foldLeft
 import java.io.PrintWriter
 import java.io.StringWriter
@@ -36,7 +43,8 @@ data class CompilationException(
   val path: Path,
   val snippet: Snippet,
   val underlying: Throwable,
-  val msg: String) : NoStackTrace(msg) {
+  val msg: String
+) : NoStackTrace(msg) {
   override fun toString(): String = msg
 }
 
@@ -123,7 +131,7 @@ val interpreter: AnkOps = object : AnkOps {
           when (state) {
             is SnippetParserState.Searching -> {
               val startMatch = fenceRegexStart.matchEntire(line)
-              if (startMatch != null) { //found a fence start
+              if (startMatch != null) { // found a fence start
                 val lang = startMatch.groupValues[1].trim()
                 val snippet = Snippet(line, lang, "")
                 Tuple3(SnippetParserState.CollectingCode(snippet), lines + line, snippets)
@@ -133,7 +141,7 @@ val interpreter: AnkOps = object : AnkOps {
               val endMatch = fenceRegexEnd.matchEntire(line)
               if (endMatch != null) { // found a fence end
                 Tuple3(SnippetParserState.Searching, lines + line, snippets + state.snippet.copy(fence = state.snippet.fence + "\n" + line))
-              } else { //accumulating code inside a fence
+              } else { // accumulating code inside a fence
                 val modifiedSnippet = state.snippet.copy(
                   fence = state.snippet.fence + "\n" + line,
                   code = state.snippet.code + "\n" + line
@@ -233,25 +241,25 @@ val interpreter: AnkOps = object : AnkOps {
 
   private fun getEngineCache(snippets: Sequence<Snippet>, compilerArgs: List<String>): Map<String, ScriptEngine> {
     val cache = engineCache[compilerArgs]
-    return if (cache == null) { //create a new engine
+    return if (cache == null) { // create a new engine
       val classLoader = URLClassLoader(compilerArgs.map { URL(it) }.toTypedArray())
       val seManager = ScriptEngineManager(classLoader)
       val langs = snippets.map { it.lang }.distinct()
       val engines = langs.toList().map {
         it to seManager.getEngineByExtension(extensionMappings.getOrDefault(it, "kts"))
       }.toMap()
       engineCache.putIfAbsent(compilerArgs, engines) ?: engines
-    } else { //reset an engine. Non thread-safe
+    } else { // reset an engine. Non thread-safe
       cache.forEach { _, engine ->
         engine.setBindings(engine.createBindings(), ScriptContext.ENGINE_SCOPE)
       }
       cache
     }
   }
 
-  //TODO Try by overriding dokka settings for packages so it does not create it's markdown package file, then for regular type classes pages we only check the first result with the comment but remove them all regardless
+  // TODO Try by overriding dokka settings for packages so it does not create it's markdown package file, then for regular type classes pages we only check the first result with the comment but remove them all regardless
   private fun generateMixedHierarchyDiagramCode(classes: List<String>): Sequence<String> {
-    //careful meta-meta-programming ahead
+    // careful meta-meta-programming ahead
     val hierarchyGraphsJoined =
       "listOf(" + classes
         .map { "TypeClass($it::class)" }

modules/ank/arrow-ank/src/main/kotlin/arrow/ank/interpreter.kt

@@ -1,10 +1,12 @@
 package arrow.aql
 
-import arrow.core.*
+import arrow.core.extensions.monoid
+import arrow.core.firstOrNone
+import arrow.core.getOrElse
+import arrow.core.identity
 import arrow.data.ForListK
 import arrow.data.fix
 import arrow.data.k
-import arrow.core.extensions.monoid
 import arrow.typeclasses.Foldable
 
 interface Count<F> {
@@ -13,13 +15,12 @@ interface Count<F> {
 
   fun <A, Z> Query<F, A, Z>.count(): Query<ForListK, Long, Long> =
     foldable().run {
-        Query(
-          select = ::identity,
-          from = listOf(from.size(Long.monoid())).k()
-        )
+      Query(
+        select = ::identity,
+        from = listOf(from.size(Long.monoid())).k()
+      )
     }
 
   fun Query<ForListK, Long, Long>.value(): Long =
     this@value.from.fix().firstOrNone().getOrElse { 0L }
-
-}
+}