How to test new rules in real world projects easily

[BraisGabin]

Expected Behavior

It should be easy to test a new rule agains some Open Source sample projects to spot issues in the rule implementation.

Current Behavior

This is really difficult we have this script: https://github.com/detekt/detekt/blob/main/scripts/get_analysis_projects.kts but it is just usefull if you don't use Type Solving.

Context

#4033 and #4394 (review)

Possible solution

We should list projects that already use detekt and use those for this tests using the --including-build feature from gradle.

[schalkms]

Another way would be to fork the projects linked in the mentioned script and configure detekt in the Gradle scripts of those forks.

[BraisGabin]

That sounds good too. We could even ask to the maintainer if they are interested in detekt and merge it.

[chao2zhang]

I used https://github.com/cortinico/kotlin-android-template to test new rules or changes to the existing rule.

[cortinico]

I used cortinico/kotlin-android-template to test new rules or changes to the existing rule.

That's a good playground. The problem is that it contains not much code so a codebase like https://github.com/mozilla-mobile/fenix would provide some real-world scenario.

[BraisGabin]

That's a good one! And they have detekt already in the project. It's not the last version but we can contribute to update it.

[BraisGabin]

I just open an issue in the Fenix repo to know if they are interested on detekt with type solving. Depending on they answer we can decide the next steps here. mozilla-mobile/fenix#23124

[github-actions]

This issue is stale because it has been open 90 days with no activity. Please comment or this will be closed in 7 days.

[TWiStErRob]

Related TWiStErRob/repros@d3019d7