Doc: type and symbol solving

[schalkms]

On the homepage there should be a separate chapter regarding rules that use type and symbol solving and how to configure them in Gradle. The existing section are missing some essential information.

• How to configure and use these rules on Android (code underneath this todo list)
• Run the detekt main -> see potential-bugs Deprecation does not work #2038 (comment)
• Mention that this is still experimental and has some peculiarities

From the Slack chat:

dependencies {
    detekt(project(":detekt-cli"))
    detektPlugins(project(":detekt-formatting"))
}
val detektAll by tasks.registering(Detekt::class) {
    description = "Runs over whole code base without the starting overhead for each module."
    parallel = true
    buildUponDefaultConfig = true
    include("**/*.kt")
    exclude("**/resources/**")
    exclude("**/build/**")
    exclude("**/*.kts")
    // baseline.set(file("$rootDir/config/detekt/baseline.xml"))
    classpath.setFrom(project.configurations.getByName("detekt"))
    reports {
        xml.enabled = false
        html.enabled = false
        txt.enabled = false
    }
}

[BraisGabin]

Is this the same as #1943 ?

[schalkms]

@BraisGabin yes thanks, this issue further improves the documentation. I closed the old one, since work is ongoing here in this issue.

[Whathecode]

For anyone using Groovy and not Kotlin for Gradle, here is an example similar to the original posted by @schalkms:

tasks.register("detektCustom", io.gitlab.arturbosch.detekt.Detekt.class) { detektTask ->
    detektTask.source = files("$projectDir/src/")
    detektTask.config.from("$rootDir/detekt.yml")
    detektTask.buildUponDefaultConfig = true
    detektTask.ignoreFailures = false
    detektTask.classpath.setFrom(project.configurations.getByName("detekt"))
}

In regards to "some peculiarities": maybe the entire output of 'unresolved references', 'cannot access' internal classes, and multi platform projects being experimental is among them?

But, ignoring that, my rule relying on type solving now seems to work.

At least, in simple projects. In a multi-project build of mine types of other projects cannot be loaded. It only works for type resolution within a single project. I tried adding /src/ folders of the other projects to the classPath set, without luck, e.g.:

    detektTask.classpath.setFrom([
        "$rootDir/carp.common/src/",
        "$projectDir/src/"
    ])