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/"
    ])

[schalkms]

@Whathecode thanks for posting more helpful content. This will be added to the page as well.

[Whathecode]

I just saw that the specific configured classpath is not even used in BindingContext other than an early out in case none are specified: https://github.com/detekt/detekt/blob/master/detekt-core/src/main/kotlin/io/gitlab/arturbosch/detekt/core/BindingContext.kt

Instead, to get multi-project analysis, you need to pass all source folders of the projects you want to analyze to source. Thus, what I tried to do above through classpath would look like:

    detektTask.source = files(
        "$rootDir/carp.common/src/",
        "$projectDir/src/"
    )

[BraisGabin]

How is the status of this issue? We did some improvements already in our documentation in this regard. Should we update the tasks that should be done so we can close this issue?

[cortinico]

How is the status of this issue? We did some improvements already in our documentation in this regard. Should we update the tasks that should be done so we can close this issue?

I have a draft for this page. I'd love to pick it up and send it out for review in the next days (unless someone else wants to pick it up).

[BraisGabin]

Sure, go for it!

[schalkms]

Sorry for the inconvenience. This one is on me.
It's a pity, but I haven't had the chance to tackle this issue and write the blog post.
However, I created the initial page in the corresponding homepage section.
Please feel free to go for it. I'll happily review the PR.

https://detekt.github.io/detekt/type-resolution.html

[cortinico]

The page is now available here: https://detekt.github.io/detekt/type-resolution.html

Feel free to contribute, open issues & give suggestions 👌

[arturbosch]

Great work! I will highlight it in the release notes to get further feedback.

[karandeep26]

can we use this approach to run type resolutions? (detektMain?)