are there ways to diagnose how long detekt checks take? When running detekt with type resolution, we’ve been surprised to find it runs even slower than android lint (!!)

I'm trying to convert my rule to using type resolution: • Added

@RequiresTypeResolution

to the rule class • In my test (using

KoTest

) I have called

createEnvironment()

• Then I switched to

MyRule().compileAndLintWithContext(env, code)

All existing tests keep passing (so no errors in test/env setup). But the following code:

fun visitNamedFunction(function: KtNamedFunction) {
  println(bindingContext.getType(function))
}

prints "*null*". I have also checked that

bindingContext == BindingContext.EMPTY

returns false. Did I miss someting?

how are you using Detekt on multiplatform projects these days? I was hoping to find a single task that would sweep my entire project but from what I see this doesn’t exist and is being tracked here, so the options I see are: • create this task myself (any directions on how I could do that?) • do something like this, it seems to work great (basically setting the module root to be the source so all source sets are considered) • run multiple tasks: ◦

detektMain

to sweep non-multiplatform stuff with type resolution ◦

detektMetadataMain

to sweep

commonMain

on all modules (found this one here) ◦

detektAndroidDebug

and

detektAndroidRelease

to sweep Android code in multiplatform modules ◦ …and how do I sweep iOS code in multiplatform modules? I’ve tried

detektMetadataIosMain

,

detektIosX64Main

,

detektIosArm64Main

and

detektIosSimulatorArm64Main

but they all seem to fail to find issues on code inside

iosMain

— should I file an issue or am I missing something? I have a minimum reproducible example here: https://github.com/tfcporciuncula/detekt-kmm-issue (this commit summarizes everything) • any other option?

Hey everyone 👋 Can I use

excludes

for every rule in a config? Sample below:

LargeClass:
  active: true
  threshold: 150
  excludes: ['**/test/**', '**/*Test.kt', '**/*Spec.kt']

If I'm running the following tasks, do I also need to run the

detekt

task, or is that covered by the others?

./gradlew detektJvmMain detektDebug detektJsMain detektMetadataMain

Is anyone at JetBrains aware of the problem where IDEA blames pretty much every bug on Detekt in the Internal Errors reporting system (https://github.com/detekt/detekt-intellij-plugin/issues/271)? I'm pretty zealous about reporting issues, but since everything is being blamed on Detekt, I can't.

Is there any way to have detekt print out the ktlint config that it uses?

I am trying to setup running tests with type resolution on detekt-rules-compose and looks like I'm stuck, need some ideas on what to try next. The process so far: 1. I need Compose to be in the classpath, so that test snippets can be correctly compiled by

compileAndLintWithContext

2. Using "native" android artifacts is not possible, because it required Android Gradle Plugin which I don't want to add (or should I try?) 3. Instead I started to use artifacts by Jetbrains's Compose Desktop, they do not require AGP 4. Now imports can be used, but if I compile a test snippet (see in thread), it fails with the "cannot inline "Box" method error" (see in thread) 5. If I a) add JB plugin to "plugins" block and b) write the same compose-code in the "Test.kt" file (not as snippet!) it compiles (without a) it gives the same "cannot-inline" error) So from 5 I can see that compiling compose code as part of the test project works, but compiling with

compileAndLintWithContext

doesn't work, it seems that compiler plugin gets applied in the first case and doesn't in second. Is there a way to make test rule aware of compiler plugins?

Hello, quick question. Is there is any way where i can check if a function has javadoc or not

Is the detekt IDE plugin supposed to use the config/detekt/detekt.yaml file? I see warnings in my IDE for things I have disabled in the yaml. Running the gradle task works fine.

Is there an API in the detekt gradle plugin for loading a config from a jar (e.g. from maven central)? Or would I have to use Gradle APIs to extract the config file from the jar?

Hi, I’m trying to configure Android project that uses Detekt and also has custom rules. For that reason application uses

detektDebug

But recently I’m trying to validate “.kts” files too. But when I configure

DetektExtension

with that paths(for root

settings.gradle.kts

files too),

detektDebug

task does not validates that files. It only validates default paths. On CI environment application is validated only with

detektDebug

task because of baseline files. Is there any way to configure

detektDebug

task inputs via Extensions? When I tried to reach the task via

tasks.named<Detekt>("detektDebug")

call it was tricky, I had to do this call on

doAfter

block. Also project uses published plugins to apply all required plugins, so ı didn’t want to add confusing tricks on there. Also I tried to configure

detektDebug

task to depend on

detekt

task and configured

DetektExtension

to only check “.kts” files but when I do that

--continue

option become useless. (CI environment uses

--continue

option and we would like to provide complete reports to developers so that they can fix all issues at once instead of waiting results for each validation errors commit by commit.)

Does anyone have an example of applying detekt inside a precompiled convention plugin for Gradle? When I try to follow https://docs.gradle.org/current/samples/sample_convention_plugins.html#compiling_convention_plugins, I'm getting

Unable to load class 'org.jetbrains.kotlin.gradle.dsl.KotlinJvmProjectExtension'.

This is an unexpected error. Please file a bug containing the idea.log file.

Is there a detekt / ktlint rule to enforce formatting of non-one-liner function-expressions to be

fun addResult(projectAnalyzerResult: ProjectAnalyzerResult) = apply {
    // ...
}

instead of

fun addResult(projectAnalyzerResult: ProjectAnalyzerResult) =
    apply {
        // ...
    }

?

Are the limitations mentioned in the compiler plugin README temporary (i.e. haven't been implemented yet) or permanent (i.e. can't be implemented in the compiler plugin)?

ℹ️ I've submitted the detekt CLI as a Nix package (currently it's made it only into the unstable channel):

$ nix-shell -p detekt -I nixpkgs=<https://github.com/NixOS/nixpkgs/archive/f80ac848e3d6f0c12c52758c0f25c10c97ca3b62.tar.gz> --command 'detekt --version'
1.22.0

Hello ! Just a simple question, I can't find the doc concerning this config:

formatting:
  active: boolean
  android: boolean
  autoCorrect: boolean

what does the android argument mean ?

Those are coming from ktlint

Oooh ok thanks

Hi! I’m trying to use

ForbiddenMethodCall

on a function annotated with

@JvmStatic

and it doesn’t appear in my Detekt warnings (I am running it with type resolution via

detektMain

). Is that a limitation or am I doing something wrong? detekt.yml

ForbiddenMethodCall:
    active: true
    methods: [
      ... // Other method definitions which are working properly
      'com.bluelinelabs.conductor.RouterTransaction.with', // Not working
    ]

Function definition (from a 3rd party lib)

package com.bluelinelabs.conductor

RouterTransaction {
...
  companion object {
    @JvmStatic
    fun with(controller: Controller): RouterTransaction = RouterTransaction(controller)
  }
}

Callsite

RouterTransaction.with(MyController())

How is Detekt supposed to be applied to multi-module Android projects, like for example the Now in Android App ? When I apply it to the project level build.gradle file, I do not get any Type Resolution tasks and when I execute the

detekt

Task nothing happens. Do I need to apply the Detekt plugin to each module individually? Edit: Adding the

detektAll

task, which is sometimes recommended does not help either

Hi all, I have a question: I'm running the detekt gradle plugin (version 1.22.0) and the

detekt

task is using different rules than

detektMain

. It's not skipping over any files, but it is applying different rules in the same file. My detekt config in gradle looks like this:

detekt {
    config = files("../detekt.yml")
    buildUponDefaultConfig = true
    source = files("src")
}

And detekt.yml looks like this:

complexity:
  active: true
  CognitiveComplexMethod:
    active: true
    threshold: 5

naming:
  InvalidPackageDeclaration:
    active: false

I'm using gradle 7.5.1 and targeting jdk 11. Namely,

detektMain

includes

UnnecessaryFilter

and

VarCouldBeVal

while

detekt

does not. Is this expected? I didn't find anything on google or in the github issues.

I'm wondering, is this a false positive for

UnnecessaryLet

?

val x = getJavaDuration()
    .toHours()
    .let { ceil(it / 24.0) }
    .roundToLong()

for ktlint embedded in detekt, is there any way to use a custom ktlint ruleset? I couldn't find anything in the detekt docs or issues mentioning how to do this...

I’m running

detekt

and updating a rule (custom), but the rule code is not the latest I have in the file. Any why I can force re-loading the rule when I run

./gradlew detekt

?

Where can I view the output of detekt. i just added it to a project. i ran the detekt gradle task... but i can't find the output in any of the build folders... 🤔

Has anyone made a custom rule/does a default one exists that check for

when

statement orders? I’m looking to have all

objects

of a sealed class/interface coming first, then the data classes, so my when(s) would look like:

when (a) {
   object1 -> {}
   object2 -> {}
   object3 -> {}
   is dc1 -> {}
   is dc2 -> {}
}

And not with

is

mixed between all the statements

hello everyone. I am following some instrctions to execute detekt in entire project, so now I have the task :

tasks.register("detektAll") {
    allprojects {
        this@register.dependsOn(tasks.withType<io.gitlab.arturbosch.detekt.Detekt>())
    }
}

I would like to run the detektAll in each build, but I unable configure that. Do you know a better approach to run detekt in entire project ???

Hi everyone. I’m using CLI in Github Actions with help of setup detekt action. I just migrated from 1.21.0 to 1.22.0 and added to

detekt.yml

new

libraries

and

formatting

sections, now build doesn’t work because apparently I need to connect plugins to CLI. Part of the action to execute detekt:

jobs:
  detekt:
    runs-on: buildjet-4vcpu-ubuntu-2004
    steps:
      - uses: actions/checkout@v3
      - name: Setup detekt
        uses: peter-murray/setup-detekt@v2
        with:
          detekt_version: 1.22.0
      - name: Run detekt
        run: detekt-cli \
          --config plugins/detekt/detekt.yml \
          --build-upon-default-config \
          --excludes '**/androidTest/**','**/build.gradle.kts'

How can I connect both

formatting

and

libraries

plugins? I’ve read the documentation, but there’s no actual example how to add the plugins.