Split kotlin modules (#316)

Author: jpenilla

build-logic/build.gradle.kts

@@ -1,5 +1,6 @@
 plugins {
     `kotlin-dsl`
+    id("org.jlleitschuh.gradle.ktlint")
 }
 
 repositories {
@@ -12,4 +13,7 @@ dependencies {
     implementation(libs.gradleTestLogger)
     implementation(libs.gradleErrorprone)
     implementation(libs.licenser)
+    implementation(libs.gradleKotlinJvm)
+    implementation(libs.gradleDokka)
+    implementation(libs.gradleKtlint)
 }

build-logic/src/main/kotlin/cloud.base-conventions.gradle.kts

@@ -27,13 +27,13 @@ tasks {
         options.errorprone {
             /* These are just annoying */
             disable(
-                    "JdkObsolete",
-                    "FutureReturnValueIgnored",
-                    "ImmutableEnumChecker",
-                    "StringSplitter",
-                    "EqualsGetClass",
-                    "CatchAndPrintStackTrace",
-                    "InlineMeSuggester",
+                "JdkObsolete",
+                "FutureReturnValueIgnored",
+                "ImmutableEnumChecker",
+                "StringSplitter",
+                "EqualsGetClass",
+                "CatchAndPrintStackTrace",
+                "InlineMeSuggester",
             )
         }
         options.compilerArgs.addAll(listOf("-Xlint:-processing", "-Werror"))

build-logic/src/main/kotlin/cloud.kotlin-conventions.gradle.kts

@@ -0,0 +1,52 @@
+import org.jetbrains.dokka.gradle.DokkaTask
+import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
+
+plugins {
+    id("cloud.base-conventions")
+    kotlin("jvm")
+    id("org.jetbrains.dokka")
+    id("org.jlleitschuh.gradle.ktlint")
+}
+
+kotlin {
+    jvmToolchain {
+        (this as JavaToolchainSpec).apply {
+            languageVersion.set(JavaLanguageVersion.of(8))
+        }
+    }
+}
+
+val compileAndTest: Configuration by configurations.creating
+listOf(configurations.compileOnly, configurations.testImplementation).forEach { config ->
+    config {
+        extendsFrom(compileAndTest)
+    }
+}
+
+dependencies {
+    compileAndTest(kotlin("stdlib-jdk8"))
+}
+
+tasks {
+    withType<DokkaTask> {
+        dokkaSourceSets.named("main") {
+            includes.from(layout.projectDirectory.file("src/main/descriptions.md"))
+            /*externalDocumentationLink { // todo: fix KDoc linking to JavaDoc
+                url.set(URL("https://javadoc.commandframework.cloud/"))
+                packageListUrl.set(URL("https://javadoc.commandframework.cloud/allpackages-index.html"))
+            }*/
+        }
+    }
+    javadocJar {
+        from(dokkaHtml)
+    }
+    withType<KotlinCompile> {
+        kotlinOptions {
+            jvmTarget = "1.8"
+        }
+    }
+}
+
+kotlin {
+    explicitApi()
+}

build-logic/src/main/kotlin/extensions.kt

@@ -4,11 +4,11 @@ import org.gradle.api.provider.Provider
 // set by GitHub Actions
 val Project.ci: Provider<Boolean>
     get() = providers.environmentVariable("CI")
-            .forUseAtConfigurationTime()
-            .map { it.toBoolean() }
-            .orElse(false)
+        .forUseAtConfigurationTime()
+        .map { it.toBoolean() }
+        .orElse(false)
 
 val Project.compileExamples: Boolean
     get() = providers.gradleProperty("compile-examples")
-            .forUseAtConfigurationTime()
-            .isPresent
+        .forUseAtConfigurationTime()
+        .isPresent

cloud-kotlin-extensions/build.gradle.kts

@@ -0,0 +1,11 @@
+plugins {
+    id("cloud.kotlin-conventions")
+}
+
+dependencies {
+    api(project(":cloud-core"))
+    api(project(":cloud-annotations"))
+    api(kotlin("reflect"))
+    api("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.5.2")
+    api("org.jetbrains.kotlinx:kotlinx-coroutines-jdk8:1.5.2")
+}

cloud-kotlin/cloud-kotlin-coroutines-annotations/build.gradle.kts

@@ -0,0 +1,7 @@
+# Module cloud-kotlin-coroutines-annotations
+
+cloud-annotations extensions for Kotlin coroutine integration.
+
+# Package cloud.commandframework.kotlin.coroutines.annotations
+
+cloud-kotlin-coroutines-annotations classes and functions.

cloud-kotlin/cloud-kotlin-coroutines-annotations/src/main/descriptions.md

@@ -21,7 +21,7 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 //
-package cloud.commandframework.kotlin.coroutines
+package cloud.commandframework.kotlin.coroutines.annotations
 
 import cloud.commandframework.annotations.AnnotationParser
 import cloud.commandframework.annotations.MethodCommandExecutionHandler
@@ -43,12 +43,15 @@ import kotlin.reflect.jvm.kotlinFunction
 /**
  * Adds coroutine support to the [AnnotationParser].
  *
+ * @param scope coroutine scope
+ * @param context coroutine context
+ * @return annotation parser
  * @since 1.6.0
  */
 public fun <C> AnnotationParser<C>.installCoroutineSupport(
     scope: CoroutineScope = GlobalScope,
     context: CoroutineContext = EmptyCoroutineContext
-) {
+): AnnotationParser<C> {
     if (manager().commandExecutionCoordinator() is CommandExecutionCoordinator.SimpleCoordinator) {
         RuntimeException(
             """You are highly advised to not use the simple command execution coordinator together
@@ -61,6 +64,8 @@ public fun <C> AnnotationParser<C>.installCoroutineSupport(
     registerCommandExecutionMethodFactory(predicate) {
         KotlinMethodCommandExecutionHandler(scope, context, it)
     }
+
+    return this
 }
 
 private class KotlinMethodCommandExecutionHandler<C>(

…lin/coroutines/KotlinAnnotatedMethods.kt …es/annotations/KotlinAnnotatedMethods.ktcloud-kotlin-extensions/src/main/kotlin/cloud/commandframework/kotlin/coroutines/KotlinAnnotatedMethods.kt renamed to cloud-kotlin/cloud-kotlin-coroutines-annotations/src/main/kotlin/cloud/commandframework/kotlin/coroutines/annotations/KotlinAnnotatedMethods.kt cloud-kotlin-extensions/src/main/kotlin/cloud/commandframework/kotlin/coroutines/KotlinAnnotatedMethods.kt renamed to cloud-kotlin/cloud-kotlin-coroutines-annotations/src/main/kotlin/cloud/commandframework/kotlin/coroutines/annotations/KotlinAnnotatedMethods.kt

@@ -21,7 +21,7 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 //
-package cloud.commandframework.kotlin.coroutines
+package cloud.commandframework.kotlin.coroutines.annotations
 
 import cloud.commandframework.CommandManager
 import cloud.commandframework.annotations.AnnotationParser
@@ -65,7 +65,7 @@ class KotlinAnnotatedMethodsTest {
         AnnotationParser(commandManager, TestCommandSender::class.java) {
             SimpleCommandMeta.empty()
         }
-            .also { it.installCoroutineSupport() }
+            .installCoroutineSupport()
             .parse(CommandMethods())
 
         commandManager.executeCommand(TestCommandSender(), "test").await()
@@ -76,7 +76,7 @@ class KotlinAnnotatedMethodsTest {
         AnnotationParser(commandManager, TestCommandSender::class.java) {
             SimpleCommandMeta.empty()
         }
-            .also { it.installCoroutineSupport() }
+            .installCoroutineSupport()
             .parse(CommandMethods())
 
         assertThrows<CommandExecutionException> {

…coroutines/KotlinAnnotatedMethodsTest.kt …nnotations/KotlinAnnotatedMethodsTest.ktcloud-kotlin-extensions/src/test/kotlin/cloud/commandframework/kotlin/coroutines/KotlinAnnotatedMethodsTest.kt renamed to cloud-kotlin/cloud-kotlin-coroutines-annotations/src/test/kotlin/cloud/commandframework/kotlin/coroutines/annotations/KotlinAnnotatedMethodsTest.kt cloud-kotlin-extensions/src/test/kotlin/cloud/commandframework/kotlin/coroutines/KotlinAnnotatedMethodsTest.kt renamed to cloud-kotlin/cloud-kotlin-coroutines-annotations/src/test/kotlin/cloud/commandframework/kotlin/coroutines/annotations/KotlinAnnotatedMethodsTest.kt

@@ -0,0 +1,7 @@
+plugins {
+    id("cloud.kotlin-conventions")
+}
+
+dependencies {
+    api(project(":cloud-core"))
+}