Toolchains docs (#5293)

* Add Groovy DSL test for jdkHome * Add jdkHome to Gradle docs
detekt · Sep 11, 2022 · 84276f2 · 84276f2
1 parent a9f51ca
commit 84276f2
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 3 deletions.
diff --git a/...e-plugin/src/functionalTest/kotlin/io/gitlab/arturbosch/detekt/DetektTaskGroovyDslSpec.kt b/...e-plugin/src/functionalTest/kotlin/io/gitlab/arturbosch/detekt/DetektTaskGroovyDslSpec.kt
@@ -51,6 +51,7 @@ class DetektTaskGroovyDslSpec {
             |    classpath.setFrom(files("config.yml"))
             |    languageVersion = "1.6"
             |    jvmTarget = "1.8"
+            |    jdkHome = file("path/to/jdk")
             |    debug = true
             |    parallel = true
             |    disableDefaultRuleSets = true
@@ -96,6 +97,7 @@ class DetektTaskGroovyDslSpec {
             |    config.setFrom(files("config.yml"))
             |    classpath.setFrom(files("config.yml"))
             |    jvmTarget = "1.8"
+            |    jdkHome = file("path/to/jdk")
             |    debug = true
             |    parallel = true
             |    disableDefaultRuleSets = true

diff --git a/website/docs/gettingstarted/gradle.mdx b/website/docs/gettingstarted/gradle.mdx
@@ -328,19 +328,30 @@ tasks.named("detekt").configure {
 
 ### Using Type Resolution
 
-Type resolution is experimental and works only for [predefined tasks listed above](#a-nametasksavailable-plugin-tasksa)
+Type resolution is experimental and works only for [predefined tasks listed above](#available-plugin-tasks)
 or when implementing a custom detekt task with the `classpath` and `jvmTarget` properties present.
 
+`jdkHome` is also available as an input. When this is unset, analysis is performed using the JDK classes of the JDK that
+Gradle is running with (shown by the `./gradlew --version` command). This can be an issue if the Gradle JDK and the
+project JDK doesn't match e.g. if Gradle runs under Java 8 but the project uses classes only available in Java 9 or
+higher. Setting `jdkHome` to the Java 9 JDK path will allow for more correct analysis.
+
+`jdkHome` and `jvmTarget` are set automatically when applying a toolchain using either
+[`java`](https://docs.gradle.org/current/userguide/toolchains.html) or
+[`kotlin`](https://kotlinlang.org/docs/gradle.html#gradle-java-toolchains-support).
+
 More information on type resolution are available on the [type resolution](type-resolution.md) page.
 
 #### Groovy DSL
 
 ```groovy
 tasks.withType(io.gitlab.arturbosch.detekt.Detekt).configureEach {
-    jvmTarget = "1.8"
+    jvmTarget = '1.8'
+    jdkHome.set(file('path/to/jdkHome'))
 }
 tasks.withType(io.gitlab.arturbosch.detekt.DetektCreateBaselineTask).configureEach {
-    jvmTarget = "1.8"
+    jvmTarget = '1.8'
+    jdkHome.set(file('path/to/jdkHome'))
 }
 ```
 
@@ -349,9 +360,11 @@ tasks.withType(io.gitlab.arturbosch.detekt.DetektCreateBaselineTask).configureEa
 ```kotlin
 tasks.withType<io.gitlab.arturbosch.detekt.Detekt>().configureEach {
     this.jvmTarget = "1.8"
+    jdkHome.set(file("path/to/jdkHome"))
 }
 tasks.withType<io.gitlab.arturbosch.detekt.DetektCreateBaselineTask>().configureEach {
     this.jvmTarget = "1.8"
+    jdkHome.set(file("path/to/jdkHome"))
 }
 ```