diff --git a/buildSrc/build.gradle.kts b/buildSrc/build.gradle.kts index ccbbbfc38a..6d480039a8 100644 --- a/buildSrc/build.gradle.kts +++ b/buildSrc/build.gradle.kts @@ -7,6 +7,7 @@ dependencies { implementation(plugin(libs.plugins.spotless)) implementation(plugin(libs.plugins.testLogger)) implementation(plugin(libs.plugins.detekt)) + implementation(plugin(libs.plugins.dokka)) } kotlin { diff --git a/buildSrc/src/main/kotlin/local.base.gradle.kts b/buildSrc/src/main/kotlin/local.base.gradle.kts index 38deebfbd0..02ed8c0eea 100644 --- a/buildSrc/src/main/kotlin/local.base.gradle.kts +++ b/buildSrc/src/main/kotlin/local.base.gradle.kts @@ -3,6 +3,7 @@ plugins { id("local.spotless") id("local.test") id("local.javalibrary") + id("local.dokka") } repositories { diff --git a/buildSrc/src/main/kotlin/local.dokka.gradle.kts b/buildSrc/src/main/kotlin/local.dokka.gradle.kts new file mode 100644 index 0000000000..405a229a58 --- /dev/null +++ b/buildSrc/src/main/kotlin/local.dokka.gradle.kts @@ -0,0 +1,3 @@ +plugins { + id("org.jetbrains.dokka") +} diff --git a/buildSrc/src/main/kotlin/local.publish.gradle.kts b/buildSrc/src/main/kotlin/local.publish.gradle.kts index f1e75d7393..1eb2f6b288 100644 --- a/buildSrc/src/main/kotlin/local.publish.gradle.kts +++ b/buildSrc/src/main/kotlin/local.publish.gradle.kts @@ -90,8 +90,6 @@ publishing { setCredentialsFromGradleProperties() } } - - println("Repository Url $url") } } } diff --git a/buildSrc/src/main/kotlin/util/Properties.kt b/buildSrc/src/main/kotlin/util/Properties.kt index c7d0d2effa..c9c518b4bf 100644 --- a/buildSrc/src/main/kotlin/util/Properties.kt +++ b/buildSrc/src/main/kotlin/util/Properties.kt @@ -6,15 +6,8 @@ import java.io.FileInputStream import java.io.InputStreamReader import java.util.* -fun Project.getLocalPropertyOrGradleProperty(propertyName: String): String? { - val property = gradleLocalProperty(propertyName) ?: getProjectProperty(propertyName) - - if (property == null) { - logger.warn("Property $propertyName not found.") - } - - return property -} +fun Project.getLocalPropertyOrGradleProperty(propertyName: String) = + gradleLocalProperty(propertyName) ?: getProjectProperty(propertyName) private fun Project.getProjectProperty(propertyName: String): String? = properties[propertyName] as String? diff --git a/gradle.properties b/gradle.properties index 8410dd611d..8572b4acd2 100644 --- a/gradle.properties +++ b/gradle.properties @@ -1,2 +1,2 @@ -org.gradle.jvmargs=-Xms512M -Xmx4g -Dkotlin.daemon.jvm.options="-Xmx1g" +org.gradle.jvmargs=-Xms512M -Xmx12g -Dkotlin.daemon.jvm.options="-Xmx1g" konsist.version=0.7.8 diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml index a79fb52af8..6e4bd6b945 100644 --- a/gradle/libs.versions.toml +++ b/gradle/libs.versions.toml @@ -19,6 +19,7 @@ kotlin-compiler = { module = "org.jetbrains.kotlin:kotlin-compiler", version.ref kotlin-jvm = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlinVersion" } kotlin-plugin-spring = { id = "org.jetbrains.kotlin.plugin.spring", version.ref = "kotlinVersion" } kotlin-plugin-jpa = { id = "org.jetbrains.kotlin.plugin.jpa", version.ref = "kotlinVersion" } +dokka = "org.jetbrains.dokka:1.8.10" spotless = "com.diffplug.spotless:6.18.0" testLogger = "com.adarshr.test-logger:3.2.0" detekt = "io.gitlab.arturbosch.detekt:1.22.0" diff --git a/lib/build.gradle.kts b/lib/build.gradle.kts index be43d0a414..3df3529ab4 100644 --- a/lib/build.gradle.kts +++ b/lib/build.gradle.kts @@ -3,7 +3,6 @@ import org.jetbrains.kotlin.gradle.tasks.KotlinCompile plugins { id("local.base") id("local.publish") - id("org.jetbrains.dokka") version "1.8.10" } dependencies { diff --git a/lib/src/integrationTest/kotlin/com/lemonappdev/konsist/core/verify/PrintDeclaration.kt b/lib/src/integrationTest/kotlin/com/lemonappdev/konsist/core/verify/PrintDeclaration.kt deleted file mode 100644 index 47954013e9..0000000000 --- a/lib/src/integrationTest/kotlin/com/lemonappdev/konsist/core/verify/PrintDeclaration.kt +++ /dev/null @@ -1,21 +0,0 @@ -package com.lemonappdev.konsist.core.verify - -import com.lemonappdev.konsist.api.Konsist -import com.lemonappdev.konsist.api.ext.sequence.print -import com.lemonappdev.konsist.api.ext.sequence.withNamePrefix -import org.amshove.kluent.shouldBeEqualTo -import org.junit.jupiter.api.Test - -class PrintDeclaration { - @Test - fun `return value after printDeclaration() is equal to original value`() { - // given - val scope = Konsist.scopeFromPackage("com.lemonappdev.konsist.core.scope.koscope") - val sut = scope - .classes() - .withNamePrefix("KoScopeForC") - - // then - sut.print() shouldBeEqualTo sut - } -} diff --git a/misc/DeveloperReadme.md b/misc/DeveloperReadme.md index 4c5c8e2709..06238c797c 100644 --- a/misc/DeveloperReadme.md +++ b/misc/DeveloperReadme.md @@ -29,6 +29,10 @@ artefact will be transferred to [maven central](https://central.sonatype.com/artifact/com.lemonappdev/konsist) repository after some time. +## Generate KDocs + +- `./gradlew dokkaHtml` - generate KDocs in `./lib/build/dokka/html/index.html` + ## Layers Below is a diagram of the layers of the `konsist` library: