Question to detekt maintainers/contributors. How d...

# detekt

[dimsuz]

Question to detekt maintainers/contributors. How do you usually debug issues with sample projects, what is the best flow for this? I mean if you presented with a project's zip-file, you unpack it, open detekt's master in your IDE and then...??? How would you go about attaching debugger to a detekt which is being run on that separate project.

Or is it vice versa: you put log-statements in detekt's code, build jar and then run "detekt" task in the sample project?

[gammax]

It really depends on the problem.

If you share a zip-file reproducer, I just open it and run it. Try to add a couple of println if I can and I’ll debug that way.

If I discover that the problem is inside Detekt codebase, then I’ll open the detekt project and use the debugger over there.

You can also use Gradle composite build to plug detekt inside another project.

[Brais Gabin]

As nico says: it depends.

If the problem is a rule I execute the project to see it. Then I try to create an unit test to reproduce the issue and then I work from there.

If the problem isn't in a rule I try to do the same but some times that's not easy. In those cases I use composite builds adding println where needed.

[dimsuz]

Oh, nice, thanks for the tips! I wanted to help debug some issues I've reported, hoping I'll find some time.

[Brais Gabin]

Let us know if you need something else!

[gammax]

I wanted to help debug some issues I’ve reported, hoping I’ll find some time.

That’s awesome 🙏 Thanks for doing it